Verze dokumentu
|
Číslo revize |
Datum platnosti |
Lokace revize |
Popis revize |
Revizi provedl/ podpis |
|
16 |
27.6.2020 |
GetCitieRouting CreatePackages |
· Nový filtr
pro vyřazené trasy · myAPI již nezobrazuje v defaultu vyřazené trasy · Nový
produkt PPL Return CZ (inbox solution) · Nová
služba Garantované večerní doručení (nahrazuje stávající Večerní doručení) |
Fňukal |
|
17 |
22.8.2020 |
GetCitiesRouting CreatePackages |
· Možnost routování na úrovni produktu pro zahraniční zásilky
(upřesnění routy pro různé druhy produktů) · PPL Return
CZ lze vytvořit jako samostatný produkt (non inbox solution) · Nové
externí číslo pro PPL Return CZ (non inbox sol) PSN · PPL Return
CZ inbox sol. – samostatný flag pro SL 1/0 |
Fňukal |
|
18 |
10.10.2020 |
GetCitiesRouting GetParcelShops |
· Routování na úrovni produktu pro zahraniční zásilky PPL
parcel Connect a PPL Parcel Business Europe (filtr pro produkty do zahraničí. Specifikujeme
routu pro každý zahraniční produkt) · ParcelShop kód pro SK jde nově filtrovat |
Fňukal |
|
19 |
20.2.2021 |
GetFreeRangeInfo CreatePackages |
· Metoda pro
získání informací k volným číselným řadám · IntegrId, pro tzv. „Integrátory“ · Povolení
dobírky do Maďarska |
Fňukal |
|
20 |
19.6.2021 |
GetFreeRangeInfo GetNumberRange GetOrders |
· Nové
rozšířené informace · Rozšíření
o IntegrID · Nová metoda
pro sledování objednávek přepravy · Nový
produkt PPL Parcel CZ Smart; PPL Parcel Smart Europe |
|
|
21 |
21.8.2021 |
CreatePackages GetPackages Všechny
metody |
· Nový MasterPackNumber – povinné v sadě · Nový filtr
InvNumbers (možnost dle čísla fa) · Formát hodin
změněn/zkrácen na HHMMSS |
Fňukal |
|
19.2.2022 |
CreatePackages GetPackages GetParcelShops |
· Nový
produkt Parcel Connect Return · Nový typ
etikety do zahraničí Common Label (CL) · Nový typ
externího čísla PJJD (zahraniční JJD číslo) · Možnost
zadat rozsah v km od PSČ nebo od GPS souřadnic |
Fňukal |
|
|
23 |
23.4.2022 |
GetFreeRangeInfo GetParcelShops |
· Filtrování
podle IntegrId · Možnost
filtrovat ActiveCardPayment |
Fňukal |
|
24 |
10.9.2022 |
GetCitiesRouting |
· Nový
atribut SecondWave · Definitivní
odstranění GetSprintRoutes a kódu palet v CreatePackages |
Fňukal |
|
25 |
22.10.2022 |
GetPackages GetVersionInformation CancelPackage |
· Možnost
stavů zásilek v EN jazyce · Nový typ
štítku: QR · Metoda pro
získávání – Novinek, informací, plánované odstávky, nasazování nových verzí
atd. · Možnost
storna balíku |
Fňukal |
|
26 |
22.11.2023 |
GetCitiesRouting Etiketa - Smartlabel |
· Změna
popisu atributu Highlighted · Změněna
podoba etikety na aktuální design – přidán region |
Kaiseršat |
|
27 |
5.3.2024 |
Číselníky |
· Doplnění
typu externího čísla POSN – registrační číslo DHL DE nutné pro doručování do Parcelboxů |
Kaiseršat |
Obsah
Etikety, váženky, routovací kódy
QR label (pouze pro Return CZ)
Zahraniční etiketa – Common Label
Logika číslování routovacího kódu
Metoda „GetVersionInformation“
Číselník návratových hodnot z volání metod
Číselník pro metodu GetPackages
PPL Parcel CZ Private + COD + Age Check 15+/18+
Zahraniční balík – PPL Parcel Connect Plus
Zahraniční balík – PPL Parcel Connect Plus
Předávací protokoly/provozní dokumenty:
CreatePackages – příklady……………………………………………………………………………...
PPL – Professional Parcel Logistic
EDI – Electronic Data
Interface – rozhraní pro elektronickou výměnu dat
XML – Extensible Markup Language - rozšiřitelný značkovací jazyk
ICT – Information and
Communication Technologies
WSDL – Web Services Description
Language
SOAP – Simple Object Access Protocol
Jeden balík (označení na etiketě – 1/1)
1/1
Sada balíků (vícekusé
zásilky)
1/5 2/5 3/5 4/5 5/5
V případě vícekusé
dobírky: 5 000 Kč 0 CZK 0
CZK 0
CZK 0 CZK
Sady balíků (více kusé zásilky)
· Sady jsou číslovány X/Y
· V případě balíku typu „dobírka“ je nosný balík (označený jako 1/Y) zatížen celkovou částkou. Ostatní jsou označeny pořadím/celkový počet (2/Y; 3/Y; atd.) a dále hodnotou dobírky „0“
· Všechny jsou PackProductType = dobírkového typu
· V datech se deklaruje pomocí:
|
Datový typ |
Povinný |
Validace |
Popis |
|
|
->PackageSet |
|
|
|
|
|
-> MasterPackNumber |
string |
Ano |
|
V případě sady balíků
- číslo nosného balíku/nadřazeného (první ze sady nebo výběrčí
dobírky). |
|
|
|
|
|
|
|
->PackageInSetNr |
int |
ANO |
|
Pořadí balíku |
|
->PackagesInSet |
int |
ANO |
Není větší > PackageInSet |
Počet balíků v sadě |
Poznámka: Dobírková částka se uvádí jako celá (zaokrouhlená)
částka.
Svoz
(návaznost – Metoda „CreatePickupOrder“)
Vyzvednutí balíku na adrese zasilatele
(většinou uvedena ve smlouvě). Balíky jsou již označeny etiketami.
Balík z libovolné adresy
(návaznost - Metoda „CreateOrders“)
Vyzvednutí balíku jinde, než je smluvně dáno.
Balíky nejsou označeny etiketou a plátce je objednavatel.
K jednotlivým produktům naleznete detailní informace na www.ppl.cz nebo v dokumentu
Základní
rozměry
Ostatní
produkty a místa:
Dalším textem v daném místě je 15 + Místo
určené pro zemi příjemce v případě
Exportnich produktů
Popis
polí:
Jedná se o typ Interleaved 2 of 5 with module 10 checksum a nikoliv Interleaved 2 of 5. Např. pro 85912345678 je kontrolní součet č. 8, takže čárový kód se vytiskne takto 859123456788 (číslo u čárového kódu tiskneme bez kontrolního součtu).
Problematika
kontrolního součtu spočívá v následujícím:
Ke kontrolnímu číslu dospějeme tak, že sečteme všechny liché pozice, tzn. v našem případě 8 + 9 + 2 + 4 + 6 + 8 = 37
Součet vynásobíme třemi, tzn. 37 x 3 = 111
K výsledku přičteme sudé pozice, tzn. 111 + 5 + 1 + 3 + 5 + 7 = 132
Kolik zbývá do další desítky tolik je naše hledané číslo neboli kontrolní součet v našem případě je to č. 8, protože tolik právě zbývá do 140.
Viz předchozí
kapitola. Toto číslo se nikde nezobrazuje a neuvádí, slouží
k určení správnosti čárového kódu!
Minimální standardní rozměry: 101 × 127 mm
Číselné rozsahy poskytuje PPL, zákazník sám negeneruje!
!!! Číslo zásilky (v jakémkoliv produktu) se NESMÍ NIKDY
opakovat!!!
Dobírka / Nedobírka
Na čtvrté pozici čísla balíku se vyskytuje 8 nebo 9 = dobírková zásilka
Typ štítku
pro product PPL Parcel Return CZ.
- PPL Logo
- QR with PackNumber
- PackNumber
- Fixní text
Je nedílnou součástí etikety. Po vytvoření etiket dle specifikací si dále volí zákazník, zda bude zásilky zároveň i vážit (není důležité, zda fyzicky nebo jen datově). Tyto informace deklaruje v datech a na váženkové části formou „xx,xx kg“. Dle obchodního a logistického případu je třeba zvolit, co bude zákazník deklarovat. Není možné metody střídat (vážené, nevážené).
Pro získávání tras (rout) se využívá metoda GetCitiesRouting.
Při používání GetCitiesRouting je NUTNÉ deklarovat i ulici příjemce kvůli
přesnému třízení!
Při routování na úrovni ulice je nutné aktualizovat/dotazovat
online s každou zásilkou!
Každý balík vložený do systému musí mít štítek „Hub Sort“ (třídící HUB štítek).
17 znakový čárový kód na štítku „Hub Sort“ obsahuje jedinečné číslo balíku, číslo cílového depa a číslo trasy nákladního vozu a další důležité informace (služby, země, … viz popis etiket).
|
Symbolika |
Code 128 B (jiný typ NENÍ přípustný) |
|
Šířka modulu |
Min. 0,375
mm |
|
Délka čar |
Min. 30 mm |
|
Počet znaků |
17 |
|
Klidová zóna |
Min. 10 mm
na obou stranách |
|
Kvalita |
Min. ANSI
GRADE B |
|
Orientace |
Všesměrový |
Příklad čárových kódů obsahuje následující informaci.
20290917084-24000
20290917084 - je jedinečné číslo balíku – PackNumber
24000
- číslo trasy – číslo trasy se získává z metody, viz kapitola Metoda „GetCitiesRouting“ – RouteCode
HK – překladiště – z Region
24 –
číslo depa – z DepoCode
V2 – druhá vlna vykládky – z SecondWave
B – z Highlighted
000 – číslo trasy – z RouteCode
77200 – PSČ
(ZipCode)
Pro exportní zásilky v rámci zemí EU jsou pevně dané směry výstupních bran. Postup tisku je naprosto shodný s tuzemskými zásilkami. V rámci některých zemí je možné volit z více produktů (detaily u obchodního zástupce nebo web PPL CZ)
Německo – PPL Parcel Connec Plus Německo – PPL Parcel Connect
Viz číselník produktů a metoda GetCitiesRouting.
Nazýváme Common Label a je standardem Deutche post DHL. Její implantace je nezbytná především pro implementaci produktů PPL Parcel Connect (PPL Return Connect). Její schválení probíhá jak na straně PPL, tak ja na straně DHL v Německu. Doba potřebná pro schválení je 4–6 týdnů. Jakékoliv odchylky v etiketě nejsou možné a vždy podléhá schválení ze strany vedení PPL CZ s.r.o., tak i Deutche post DHL.
Vycházíme z minimalistické verze, jejíž nejmenší rozměr je 150×100 mm.
Je nutné dodržet dané rozměry.
Prefix Název produktu Logo DHL
Adresa příjemce
Čtyři rohy: Umístěte 4 rohy kolem adresy
·
tloušťka čáry: 1,0
mm (základní pravidlo), nejméně 0,7 mm (odchylka)
·
délka čáry: 10 mm
(základní pravidlo), nejméně 7 mm (odchylka)
·
mezi adresou a 4
rohy dodržte klidovou zónu: 10 mm (základní pravidlo), nejméně 5 mm (odchylka).
·
dodržení klidové
zóny 5 mm (základní pravidlo), alespoň 3 mm (odchylka), mezi rohy a řádky nad a
pod adresním segmentem
Variabilní symbol (pokud je COD)
Zákaznická reference
Počet [Count] – pořadí / počet balíků. V Případě PPL
Parcel connect a Return connect
je VŽDY 1/1
Trojúhelník s nápisem COD (rozměry níže); částka a
měna.
|
Produkt |
Označení |
Vysvětlivky |
|
Cash on delivery |
Example: |
symbol: trojúhelník velikost trojúhelníku: 30 mm × 10 mm (š ×
v) umístění: vlevo; pokud je v tomto řádku více značek,
musí být COD vždy umístěna vlevo. Text: COD Tisk: bílá písmena na černém
pozadí nebo černá písmena v černém rámečku s bílým pozadím Hodnota se dvěma číslicemi za čárkou. |
PL28233 – Země určení+PSČ
+ 70 – produktová informace:
*70,72,74
= kódy níže
000002 – fix COD
000000 – fix nonCOD
JJD14902 – prefix
0422609–7 čísel. CustID
zákazníka. Pokud je méně než 7, přidává se 0.
000001753 – pořadové číslo
Vygenerovanou číselnou řadu dostane zákazník na
požádání v řádku stovek miliónů.
JJD oddělit po 4 číslech
|
Produkt |
Auto Sort |
Vysvětlivky |
|
Parcel Connect |
70 |
Also: Parcel
International 4You |
|
PPL Parcel Connect + |
74 |
|
|
Parcel Return Connect |
72 |
|
|
No feature |
00 |
|
|
Parcel Shop Delivery |
53 |
Manned access
points, incl. PostOffices |
|
Parcelstation Delivery |
54 |
Unmanned access points |
|
Dobírka/Cash on Delivery (COD) |
002 |
Kód musí být uveden s počátečními nulami |
Následující tabulka určuje, zda je segment (nebo jeho obsah) povinný (M), podmíněný (C ) nebo nepovinný (O). Pokud nepovinný segment neobsahuje žádné informace, není nutné zobrazovat prázdný blok segmentu. Blok může být vynechán. Podmíněný (C) znamená, že segment označení je povinný, pokud je splněna podmínka.
|
1 – Header: Company logo
(C), Product name (C) |
|
2 – Ship from address
(M), sender contact information (O) |
|
3
– Ship to address (M), recipient contact information (O) |
|
4 – Manual sorting
instruction (O) |
|
5 – Product features (C):
handling, date & time |
|
6 – Shipment information
(O) |
|
7 – Manual handling
instruction (C) |
|
8 – Pre-Instruction (O),
GTB (M) |
|
9 – Customer information
(O) |
|
10 – Routing information
(M) |
|
11 – Unique item identifier: License plate (M) |
|
12 – Label version (C) |
Znaky, které jsou důležité pro třídění a manipulaci, musí být dobře čitelné i za neideálních světelných podmínek. Platí následující minimální velikosti znaků:
· pro informace / kódy ve funkci produktu, počet (v informacích o zásilce) a segmenty pro ruční třídění: 5 mm (20pt)
· pro název produktu: 5 mm (20pt) tučně
· pro adresu příjemce: 2,5 mm (9pt), maximálně 5 mm (20pt).
· pro čísla čárových kódů, adresu odesílatele, text zásilky, text informací o zákazníkovi: 2 mm (8pt)
· pro telefonní číslo: 1,6 mm
Výška znaků ostatních segmentů štítku musí být vytištěna v přiměřeně čitelné velikosti.
Pro automatické třídění v síti Parcel Europe lze pro síťový produkt používat pouze následující typy jednorozměrných identifikačních čárových kódů:
· První čárový kód Code 128, max. 35 míst (alfanumerické znaky)
· Druhý čárový kód Code 128, 20místný (číselné znaky).
Čitelná reprezentace řetězce čárového kódu musí potvrzovat všechny zakódované znakové prvky. Vždy musí obsahovat identifikátor dat/aplikace (J nebo 00). Reprezentace čárového kódu musí být vytištěna nad nebo pod čárovým kódem.
PODMÍNKOU PRO PRODUKT RETURN CONNECT IMPORT a RETURN CONNECT
EU JE GENEROVÁNÍ ETIKET PARCEL CONNECT!!!
*příklad datové výměny na konci dokumentace
*příklad datové výměny na konci dokumentace
*příklad datové výměny na konci dokumentace
|
Label segment |
Minimum
height (before) |
Dimensions
(in mm) |
||
|
Header |
7 (10) |
CMR text 5mm
(14pt) narrow bold Width: 22mm |
Product name text
5mm narrow bold; Width: 53mm |
Logo height 4mm Width: 19mm |
|
Space below
0,5mm; no line to next segment |
||||
|
From address |
6 (29) |
Text 2mm; 2
lines; 0,5mm line space 81 digits fit in
line width 94mm Space above
0,5mm; space below 1mm; no line to next segment |
||
|
To address |
31,5 (29) |
Text 2,5mm; 5
lines; 0,5mm line space 42 digits fit in
width 76mm (inside hooks) Hook lines (W*L)
1* 7mm Distances:
text-2-hook 5mm; hook-2-above/below 3mm Space above 2mm;
space below 3mm; line to next segment |
Contact/phone
rotate vertically; text 1,6mm |
|
|
Manual sort instruction |
5 (10) |
Text 4mm Space above
0,5mm; space below 0,5mm; line to next segment |
||
|
Feature codes |
6,5 (10) |
Handling text
5mm, bold; white in black area |
Date & time
text 5mm |
|
|
Space above
0,5mm; space below 0,5mm; line to next segment |
||||
|
Shipment info |
6,5 (20) |
Text 2mm; title
(i.e. Weight) text 2mm bold; 0,5mm line space Space above
0,5mm; space below 0,5mm; no line to next segment |
||
|
Handling instruction |
15 (17) |
COD triangle
(H*W) 15*30mm; COD text 5mm bold; EUR text 2,5mm |
Version rotate vertically; text 1,6mm |
|
|
Space above
0,0mm; space below 0,0mm; no line to next segment |
||||
|
Pre-instruction, CMR |
0 (10) |
n.a. (no pre-instruction feature for Connect; show CMR in header)
|
||
|
Customer info |
12,5 (30) |
Not defined |
||
|
Routing barcode |
31 (37) |
Barcode 25mm;
number text 2mm distance:
barcode-2-number 0,5mm Space above 3mm; space
below (barcode) 2mm; no line to next segment |
||
|
Identifier barcode |
29 (38) |
Barcode 25mm;
number text 2mm distance:
barcode-2-number 0,5mm Space above 1mm;
space below barcode 4mm to label border (below number 1,5mm); no line to next
segment |
||
|
Label version |
0 (3) |
n.a. (print vertically in handling instruction
segment) |
||
|
Total length |
150 (243) |
|
||
Klidová zóna na levé a pravé straně okraje štítku: od textu 3 mm, od čárových kódů 5 mm.
Klidová zóna po spodní okraj štítku: od čárového kódu 4 mm (od čísla 1.5 mm), po horní okraj štítku: 1.5 mm, od čárového kódu: 1.5 mm, od čárového kódu: 1.5 mm.
Webová služba myAPI (dále jen myAPI) je určená pro zákazníky a partnery společnosti PPL CZ s.r.o. (dále jen PPL), kteří prostřednictvím této služby mají potřebu obousměrně přenášet data mezi svým informačním systémem a informačním systémem společnosti PPL.
myAPI je implementována na serverech PPL a je přístupná přes internet. Poskytuje sadu metod umožňujících výměnu údajů o zásilkách, stavech zásilek, objednávkách svozu. Dále poskytuje vždy aktualizovaný seznam Parcelshopů, seznam tras atd.
Projekt myAPI se neustále rozvíjí a soubor metod se průběžně doplňuje o další nové služby, z tohoto důvodu je při provádění nezbytné sledovat nejaktuálnější verzi této dokumentace. Obsah myAPI je zdokumentován a dostupný prostřednictvím služby WSDL
URL adresa k WSDL: https://myapi.ppl.cz/MyApi.svc?singleWsdl
Popis stylu
dokumentu
Dokumentace obsahuje podrobný popis každé metody s následujícími detaily:
· popis jednotlivých atributů
· popis hodnot atributů jejich omezení
· vzorová data dotazu SOAP 1.2
· návratové hodnoty
· chybové hodnoty
· číselníky
Ve vzorových údajích se vyskytují mezi některými elementy otazníky, které označují místa, kde se zadávají hodnoty. Vstupní hodnoty použité jako příklad a návratové hodnoty z volání metod, jsou v tomto dokumentu zvýrazněné červenou barvou. U SOAP 1.1 je třeba do hlavičky zadat i SOAPAction.
Příklad:
POST /myApi.asmx HTTP/1.1
Host: www.ppl.cz Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://myapi.ppl.cz/v1/IMyApi2/Login"
V uvedeném příkladu myAPI udává název API, ve které se nacházejí požadované metody a Login je název volané metody.
Metody se rozdělují do dvou základních skupin, jsou to metody operační a business metody. Operační metody zajišťují pro myAPI základní provozní služby. Soubor business metod, zajistí výměnu údajů mezi IS partnera a IS PPL.
Operační metody zajišťují možnost přihlášení k myAPI, poskytují možnost ověření připojení a identifikaci aktuální verze myAPI, ke které je klient připojen.
Metoda isHealtly poskytuje klientovi informaci o stavu připojení k myAPI. K ověření stavu připojení se nevyžaduje autentifikace ke službě myAPI. Metoda nemá žádné vstupní argumenty.
XML struktura dotazu pro metodu isHealtly:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:IsHealtly/>
</soapenv:Body>
</soapenv:Envelope>
Příklad XML
struktury odpovědi metody isHealtly:
Tabulka 1 - Popis výstupních atributů metody is Healthy
|
Název elementu |
Typ |
Popis |
|
IsHealtlyResult |
string |
stav služby |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<IsHealtlyResponse
xmlns="http://myapi.ppl.cz/v1">
<IsHealtlyResult>Healthy</IsHealtlyResult>
</IsHealtlyResponse>
</s:Body>
</s:Envelope>
Metoda Login zajišťuje klientovi možnost přihlásit se k webové službě myAPI. Zadáním vstupních parametrů a zavoláním metody, po úspěšném ověření přihlašovacích údajů, metoda vygeneruje TOKEN, který klient může použít pro volání dalších metod. TOKEN je platný 30 minut, a proto se musí po uplynutí této doby znovu vygenerovat opětovným zavoláním metody Login. Každá z business metod po svém zavolání také vygeneruje nový TOKEN s platností 30 minut, který může být také použit při volání dalších business metod až do jeho doby použitelnosti.
Tabulka 2 - Popis vstupních atributů metody Login
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
Pro
přihlášení je třeba zadat buď token nebo Login |
Autentifikace |
|||
|
-> AuthToken |
|
|
Ano |
|
Autentifikační ticket |
|
-> CustId |
int |
ID zákazníka |
Dodá PPL |
||
|
-> Password |
string |
Délka: 32 |
Heslo |
Dodá PPL |
|
|
-> SubjectId |
int |
|
|
ID Subjektu |
Pro sledování zásilek z více registrací |
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
Dodá PPL |
XML struktura dotazu pro metodu Login:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:Login>
<v1:Auth>
<v1:CustId>MojeID</v1:CustId>
<v1:Password>MojeHeslo</v1:Password>
<v1:UserName>MojePrihlasovaciJmeno</v1:UserName>
</v1:Auth>
</v1:Login>
</soapenv:Body>
</soapenv:Envelope>
Příklad XML struktury odpovědi metody Login:
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope
xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header />
<s:Body>
<LoginResponse xmlns="http://myapi.ppl.cz/v1">
<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>tdI5kXejGU8hWkR/Ld8FEfMbBAAAugQAAGcDv5wKz1ppl2XEiQp1811ZqY9HdAopqyqCRcqZZqOkyluJCeHfsshw1QIM4N09Pd0UDYIHA==</AuthToken>
</LoginResult>
</LoginResponse>
</s:Body>
</s:Envelope>
Chybové návratové hodnoty metody Login:
Metoda Login při zadání nesprávného přihlašovacího jména nebo hesla vrátí chybovou hodnotu
Tabulka 3 - Popis chybových návratových hodnot metody Login
|
Kód
chyby |
Popis
chyby |
Poznámka |
|
s:AS1 |
Pokus o přihlášení byl neúspěšný, zkontrolujte
uživatelské jméno a heslo. |
|
Metoda Version poskytuje klientovi informaci o aktuální verzi myAPI. K ověření stavu připojení se nevyžaduje autentifikace ke službě myAPI. Metoda nemá žádné vstupní argumenty.
Tabulka 4 - Popis výstupních atributů metody Version
|
Název elementu |
Typ |
Popis |
|
VersionResult |
string |
aktuální verze služby myAPI |
XML struktura dotazu pro metodu Version
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:Version/>
</soapenv:Body>
</soapenv:Envelope>
Příklad XML struktury odpovědi metody Version
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<VersionResponse xmlns="http://myapi.ppl.cz/v1">
<VersionResult> 1.19.1014.1322 </VersionResult>
</VersionResponse>
</s:Body>
</s:Envelope>
Soubor business metod poskytuje skupinu metod pro výměnu dat mezi IS partnera a IS PPL, jako například generování aktuálního seznamu ParcelShopů, vytvoření zásilky, přepravy, objednávky svozu atd. Dále budou všechny tyto metody popsané.
Metoda GetParcelShops poskytuje klientovi v závislosti na vstupních kritériích aktuální seznam Parcelshopů (PS). Odpověď metody obsahuje informace o názvu firmy, adrese, poloze (GPS), kontaktních údajích a otevíracích hodinách provozu ParcelShopu.
POZOR! K aktualizaci dochází denně! A je možné doručovat
i do vybraných zahraničních Parcelshopů. Aktualizace
doporučujeme kolem 4–5 hodiny ranní!
Tvorba etikety:
Na etiketu se přenáší informace o Parcelshopu a jeho adrese. Na etiketě se uvede jen osoba, která si má balík převzít. Viz vzor Etikety – balík na ParcelShop
Tabulka 5 - Popis vstupních atributů metody GetParcelShops
|
Název elementu |
Datový typ |
Datový formát |
Povinný údaj |
Validace |
Popis |
|
string |
Délka: 50 |
Ne |
|
Typ výdejního
místa. Viz číselník 0 Číselník výdejních míst |
|
|
boolean |
|
Ne |
|
Možnost platby kartou |
|
|
City |
string |
Délka: 50 |
ANO/ne |
|
Město |
|
Code |
string |
Délka: 50 |
NE |
|
Kód parcelshopu. Pokud se
hodnota ponechá prázdná, metoda vrátí seznam všech PS z CZ |
|
CountryCode |
string |
Délka: 2 |
ANO |
Číselník zemí |
Kód země. Minimálně jeden z elementů CountryCode a Code musí být
vyplněn. |
|
|
|
Ne |
|
GPS souřadnice |
|
|
Longitude |
|
|
Ne |
|
GPS souřadnice |
|
Radius |
int |
Délka: 2 |
Ne |
|
v KM. Max 99 |
|
string |
Délka: 10 |
ANO/Ne |
|
PSČ |
XML struktura dotazu pro metodu GetParcelShops:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:GetParcelShops>
<v1:Filter>
<v1:Code>KM10128401</v1:Code>
<v1:CountryCode>CZ</v1:CountryCode>
</v1:Filter>
</v1:GetParcelShops>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody GetParcelShops:
Tabulka 6 - Popis výstupních atributů metody GetParcelShops
|
Název elementu |
Typ |
Popis |
|
AccessPointType |
string |
Typ výdejního místa |
|
City |
String |
Město |
|
Country |
string |
Země (zatím se používá) |
|
Email |
string |
Kontaktní email |
|
Fax |
variant |
Fax na provoz |
|
GPSLocation |
GPS souřadnice |
|
|
-> GPSLocation
-> GPS_E_D |
float |
|
|
-> GPSLocation
-> GPS_E_M |
float |
|
|
-> GPSLocation
-> GPS_E_S |
float |
|
|
-> GPSLocation
-> GPS_N_D |
float |
|
|
-> GPSLocation
-> GPS_N_M |
float |
|
|
-> GPSLocation
-> GPS_N_S |
float |
|
|
Name |
string |
Název firmy provozující Parcelshop |
|
Name2 |
string |
Název firmy provozující Parcelshop |
|
OrgId |
string |
IČO firmy |
|
OrgVatId |
string |
DIČ firmy |
|
ParcelShopCode |
string |
Kód Parcelshopu |
|
Phone |
variant |
Kontaktní telefon |
|
Position |
string |
Pozice |
|
QrCode |
string |
QR kód |
|
Street |
string |
Ulice a číslo popisné |
|
WorkHours |
|
|
|
-> MyApiKTMWorkHour |
Informace o otevíracích hodinách |
|
|
-> Day |
int |
1 - Neděle |
|
-> From |
time |
začátek intervalu otevření provozu |
|
-> To |
time |
konec intervalu otevření provozu |
|
-> ZipCode |
string |
PSČ |
Příklad
XML struktury odpovědi metody GetParcelShops:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetParcelShopsResponse xmlns="http://myapi.ppl.cz/v1">
<GetParcelShopsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken i:nil="true"/>
<ResultData>
<MyApiParcelShop>
<City>Kroměříž</City>
<Country>CZ</Country>
<Email>info@obchodproturisty.cz</Email>
<Fax/>
<GPSLocation>
<GPS_E_D>17</GPS_E_D>
<GPS_E_M>23</GPS_E_M>
<GPS_E_S>42.9480</GPS_E_S>
<GPS_N_D>49</GPS_N_D>
<GPS_N_M>17</GPS_N_M>
<GPS_N_S>46.9140</GPS_N_S>
</GPSLocation>
<Name>FRČÍME s.r.o.</Name>
<Name2>PPL Parcelshop 101</Name2>
<OrgId>26307642</OrgId>
<OrgVatId>CZ26307642</OrgVatId>
<ParcelShopCode>KM10176701</ParcelShopCode>
<Phone>776372463</Phone>
<Position i:nil="true"/>
<QrCode i:nil="true"/>
<Street>1. máje 281</Street>
<WorkHours>
<MyApiKTMWorkHour>
<Day>3</Day>
<From>12:00</From>
<To>12:00</To>
</MyApiKTMWorkHour>
<MyApiKTMWorkHour>
<Day>3</Day>
<From>05:00</From>
<To>05:00</To>
</MyApiKTMWorkHour>
<MyApiKTMWorkHour>
<Day>4</Day>
<From>12:00</From>
<To>12:00</To>
</MyApiKTMWorkHour>
<MyApiKTMWorkHour>
<Day>4</Day>
<From>05:00</From>
<To>05:00</To>
</MyApiKTMWorkHour>
</WorkHours>
<ZipCode>76701</ZipCode>
</MyApiParcelShop>
</ResultData>
</GetParcelShopsResult>
</GetParcelShopsResponse>
</s:Body>
</s:Envelope>
Metoda GetCitiesRouting poskytuje klientovi seznam směrů/tras pro účely tisku na štítku, routovací část. Díky tisku těchto náležitostí je možné urychlit, a hlavně zpřesnit proces přepravy. Metoda také vrací informace o možnostech doručení, produktů a typ trasy – dopolední balík, garantované večerní doručení a další služby.
Při routování
na úrovni ulice je nutné aktualizovat/dotazovat online s každou zásilkou!
Tabulka 7 - Popis vstupních atributů metody GetCitiesRouting
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
|
Ano |
Pro přihlášení je třeba zadat, buď token nebo Login |
Autentifikace |
|
-> AuthToken |
|
|
Autentifikační ticket |
||
|
-> CustId |
int |
|
ID zákazníka |
||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
-> Filter |
|
|
|
|
|
|
-> CountryCode |
string |
Délka: 2 |
Ano |
Minimálně jeden ze dvou elementů CountryCode a ZipCode musí být
vyplněn. |
Kód státu podle číselníku Číselník zemí |
|
-> DateFrom |
DateTime |
YYYY-MM-DD |
Ne |
Pokud se nezadá datum, XML nesmí obsahovat
element <DateFrom> |
Datum OD |
|
-> EveningDelivery |
Bool |
|
Ne |
|
1 / 0 |
|
-> MorningDelivery |
Bool |
|
Ne |
|
1 / 0 |
|
-> PackProductType |
string |
|
|
|
Pouze exportní produkty; rozlišení produktových tras. Aktuálně Parcel Connect a Business Europe (viz číselníky) |
|
->
Post |
string |
|
Ne |
|
Město |
|
->
Rejected |
Bool |
|
Ne |
|
Displays rejected
(invalid) routes |
|
-> SaturdayDelivery |
Bool |
|
Ne |
|
1 / 0 |
|
->Street |
string |
|
Ne |
V případě zadání ulice, musí být
zadáno I PSČ (nebo
mesto). Zadávejte zásadně
ulice + číslo popisné (příp. Orientační) |
Pokud je vyplněna neznámá ulice, vrátí
výsledek na úrovni PSČ. |
|
-> ZipCode |
string |
Délka: 10 |
Ne |
Pokud se nezadá žádná hodnota, metoda vrátí
všechny směry. Minimálně jeden ze dvou elementů CountryCode
a ZipCode musí být vyplněn. |
Pokud je vyplněno neznámé PSČ, vrátí se
nejbližší nižší PSČ. |
XML struktura dotazu pro metodu GetCitiesRouting
*** PŘÍKLAD 1 (dotaz na všechny směry) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:GetCitiesRouting>
<v1:Auth>
<v1:AuthToken>e3mmlo7o+RAyrD2STiL5Nv.....AAugQAAGcAAAAa1ksyyjQ=</v1:AuthToken>
</v1:Auth>
<v1:Filter>
<v1:CountryCode>CZ</v1:CountryCode>
</v1:Filter>
</v1:GetCitiesRouting>
</soapenv:Body>
</soapenv:Envelope>
XML struktura dotazu pro metodu GetCitiesRouting
*** PŘÍKLAD 2 (dotaz na směry podle filtru ulice a PSČ) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:GetCitiesRouting>
<v1:Auth>
<v1:AuthToken>e3mmlo7o+RAyrD2STiL5Nv.....AAugQAAGcAAAAa1ksyyjQ=</v1:AuthToken>
</v1:Auth>
<v1:Filter>
<v1:CountryCode>CZ</v1:CountryCode>
<v1:Street>Hřbitovní 12</v1:Street>
<v1:ZipCode>79401</v1:ZipCode>
</v1:Filter>
</v1:GetCitiesRouting>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody GetCitiesRouting:
Tabulka 8 - Popis výstupních atributů metody Get Cities Routing
|
Název elementu |
Typ |
Popis |
|
MyApiCityRouting |
|
|
|
-> Changed |
string |
Datum změny směru - formát:
{YYYY-MM-DD} T {hh: MM: SS} |
|
-> City |
string |
Město |
|
-> CountryCode |
string |
Kód země podle číselníku Číselník zemí |
|
-> Created |
datetime |
Datum vytvoření směru - formát:
{YYYY-MM-DD} T {hh: MM: SS} |
|
-> DepoCode |
Varchar (2) |
Kód přiřazeného depa (tiskne se na tzv. váženku) |
|
-> Highlighted |
boolean |
true – do rámečku se tiskne B |
|
-> PackProductName |
string |
Viz. Číselník produktů (PPT 36,37, 9,10) |
|
-> PackProductType |
string |
Viz. Číselník produktů (PPT 36,37, 9,10) |
|
-> Post |
string |
Virtuální depo |
|
-> Region |
string |
Překladiště PPL – tiskneme do rámečku |
|
-> Reject |
boolean |
Vyřazení směru |
|
-> RouteCode |
string |
Směr |
|
->SecondWave |
Boolean |
V2 |
|
-> Services |
variant |
Služby (garantované večerní doručení, dopolední
balík) |
|
-> Street |
string |
Pokud je
nalezena ulice, je vyplněno ulicí. |
|
-> ZipCode |
string |
PSČ |
Příklad XML struktury odpovědi metody GetCitiesRouting:
<s:Envelope
xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetCitiesRoutingResponse xmlns="http://myapi.ppl.cz/v1">
<GetCitiesRoutingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>8WXqYT………………………………………..2GjhnlfI77w</AuthToken>
<ResultData>
<MyApiCityRouting>
<Changed>2022-03-30T14:02:04</Changed>
<City>Krnov</City>
<CountryCode>CZ</CountryCode>
<Created>2020-10-09T08:17:21</Created>
<DepoCode>77</DepoCode>
<Highlighted>true</Highlighted>
<PackProductName
i:nil="true"/>
<PackProductType
i:nil="true"/>
<Post>Krnov
1</Post>
<Region>77</Region>
<Reject>false</Reject>
<RouteCode>07075</RouteCode>
<SecondWave>false</SecondWave>
<Services>
<MyApiCityRouteSvc>
<Code>SAT</Code>
<Value>false</Value>
</MyApiCityRouteSvc>
<MyApiCityRouteSvc>
<Code>ED</Code>
<Value>false</Value>
</MyApiCityRouteSvc>
<MyApiCityRouteSvc>
<Code>MD</Code>
<Value>false</Value>
</MyApiCityRouteSvc>
</Services>
<Street>Hřbitovní</Street>
<ZipCode>79401</ZipCode>
</MyApiCityRouting>
</ResultData>
</GetCitiesRoutingResult>
</GetCitiesRoutingResponse>
</s:Body>
</s:Envelope>
Metoda GetPackages je určena klientovi pro vyhledávání zásilek a detailních údajů, jako například číslo balíku, stav doručení, váha, datum vážení, doručení atd. Zákazník se dotazuje například rozsahem datumu, konkrétním číslem balíku.
Tabulka 9 - Popis vstupních atributů metody GetPackages
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
Ano |
Pro přihlášení je třeba zadat buď token, nebo Login |
Autentifikace |
|
|
-> AuthToken |
|
|
Autentifikační ticket |
||
|
-> CustId |
int |
|
ID zákazníka |
||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
int |
|
|
Subject ID |
Pro sledování
zásilek z více registrací |
|
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
->Filter |
|
|
|
|
|
|
-> CustRefs |
string |
Délka: 40 |
Ne |
|
Zákaznická reference |
|
-> DateFrom |
DateTime |
YYYY-MM-DD |
Ne |
|
Datum OD |
|
-> DateTo |
DateTime |
YYYY-MM-DD |
Ne |
|
Datum DO |
|
-> InvNumbers |
string |
|
Ne |
|
Číslo faktury |
|
-> PackNumbers |
string |
Délka: 11 |
Ne |
|
Číslo zásilky |
|
-> PackageStates |
string |
|
Ne |
|
Dle číselníku Číselník stavů
zásilek |
|
-> StatusLang |
string |
Délka: 2 |
Ne |
|
Zvolený jazyk statusů cs/en (fefault
cs) |
|
->VariableSymbolsCOD |
long |
|
Ne |
Pouze čísla |
Dle VS dobírky |
XML struktura dotazu pro metodu GetPackages
*** PŘÍKLAD 1 (dotaz na všechny zásilky zákazníka v určitém časovém úseku podle filtru OD ... DO) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"
xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soapenv:Header/>
<soapenv:Body>
<v1:GetPackages>
<v1:Auth>
<!--Optional:-->
<v1:AuthToken>xP5xKnD9TT4cIS9jfPcGBfMbBAAAugQAA.......uhNyeHSfPY=</v1:AuthToken>
</v1:Auth>
<v1:Filter>
<v1:DateFrom>2016-10-01</v1:DateFrom>
<v1:DateTo>2016-11-26</v1:DateTo>
</v1:Filter>
</v1:GetPackages>
</soapenv:Body>
</soapenv:Envelope>
XML struktura dotazu pro metodu GetPackages
*** PŘÍKLAD 2 (dotaz na konkrétní zásilku zákazníka podle čísla zásilky) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soapenv:Header/>
<soapenv:Body>
<v1:GetPackages>
<v1:Auth>
<!--Optional:-->
<v1:AuthToken>xP5xKnD9TT4cIS9jfPcGBfMbBAAAugQAA.......uhNyeHSfPY=</v1:AuthToken>
</v1:Auth>
<v1:Filter>
<v1:PackNumbers>
<arr:string>80912345678</arr:string>
</v1:PackNumbers>
</v1:Filter>
</v1:GetPackages>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody GetPackages:
Tabulka 10 - Popis výstupních atributů metody GetPackages
|
Název elementu |
Typ |
Popis |
|
->BackDate |
DateTime |
Datum odeslání zásilky zpět. Pokud je vyplněno, zásilka
nebyla doručena. |
|
->BackPackNumber |
string |
|
|
->BackPackNumberActive |
bool |
|
|
->BackedDoc |
string |
Číslo zpětné zásilky |
|
->DelivDate |
DateTime |
Datum doručení |
|
->DeliveryToKtm |
bool |
Doručení na ParcelShop |
|
->DelivPerson |
string |
Příjemce zásilky |
|
->DepInCode |
string |
Kód vstupního depa |
|
->DepInName |
string |
Název vstupního depa |
|
->DepOutCode |
string |
Kód výstupního depa |
|
->DepOutName |
string |
Název výstupního depa |
|
->DepoCode |
string |
kód depa |
|
->HubDate |
DateTime |
Datum přijetí na centrálu |
|
->LoadDate |
DateTime |
Datum nakládky |
|
->NotDelivDate |
DateTime |
Datum nedoručení |
|
->Note |
String |
Poznámka |
|
->OutDepDate |
DateTime |
Datum odjezdu z výstupního depa |
|
->PackNumber |
string |
Číslo balíku |
|
->PackProductType |
int |
Typ produktu podle číselníku Číselník produktů |
|
->PackageInSetNr |
int |
|
|
->PackagesInSet |
int |
Počet
balíků v sadě |
|
->PackageStatuses |
|
Informace o statusech vztahujících se k zásilce
podle číselníku Číselník statusů |
|
->Note2 |
string |
Poznámka 2 |
|
->StaID |
int |
ID statusu |
|
->StatusDate |
DateTime |
Datum vytvoření statusu |
|
->StatusName |
string |
Název statusu |
|
->PackagesExtNums |
|
Informace o externích číslech zásilky podle
číselníku Číselník typu externích čísel |
|
->Code |
string |
Kód typu čísla zásilky |
|
->ExtNumber |
string |
Externí číslo zásilky |
|
->PackageServices |
|
Informace o službách zásilky |
|
->Price |
decimal |
Částka za službu |
|
->PriceCurrency |
string |
Měna částky za službu podle číselníku Číselník povolených měn |
|
->SrvCode |
string |
Kód služby přiřazené k zásilce podle číselníku
5.11Číselník služeb |
|
->PalletInfo |
|
Informace o paletách |
|
->ColliNumber |
string |
číslo kusu |
|
->Hight |
int |
výška |
|
->Length |
int |
Délka |
|
->Weight |
Decimal |
váha |
|
->Width |
int |
šířka |
|
->WrapCode |
string |
Typ obalu zásilky |
|
->ManipulationType |
int |
typ manipulace |
|
->PEURCount |
int |
Počet palet k vrácení |
|
->PackDesc |
string |
Popis zásilky |
|
->PickupCargoTypeCode |
string |
Kód typu Svozu |
|
->Volume |
decimal |
objem zásilky |
|
->PaymentInfoOut |
|
Informace o platbách |
|
->BankAccount |
string |
Číslo účtu klienta, na který bude dobírka
odeslána |
|
->BankCode |
string |
Kód banky pro platbu dobírky klientovi |
|
->CanPayByCard |
string |
Povolena platba kartou |
|
->CodBankStatementDate |
DateTime |
Datum odeslání příkazu do banky |
|
->CodCurrency |
string |
měna dobírky |
|
->CodPaidDate |
DateTime |
Datum platby dobírky |
|
->CodPaymentAccDate |
DateTime |
Datum odeslání peněz z PPL CZ do banky
klienta |
|
->CodPrice |
decimal |
částka dobírky |
|
->CodVarSym |
long |
Variabilní symbol dobírky |
|
->IBAN |
string |
IBAN |
|
->InvDate |
DateTime |
Datum vystavení faktury |
|
->InvNumber |
string |
číslo faktury |
|
->PaidByCard |
bool |
Placené kartou |
|
|
||
|
->SpecSymbol |
string |
Specifický symbol pro platbu dobírky klientovi |
|
->Swift |
string |
SWIFT |
|
->Recipient |
|
Informace o příjemci |
|
->City |
string |
Město |
|
->Contact |
string |
Kontaktní osoba |
|
->Country |
string |
Stát Číselník zemí |
|
->Email |
string |
E-mail |
|
->Name |
string |
Jméno |
|
->Name 2 |
string |
Jméno 2 |
|
->Phone |
string |
Telefon |
|
->Street |
string |
Ulice |
|
->ZipCode |
string |
PSČ |
|
->Sender |
|
Informace o odesílateli |
|
->City |
string |
Město |
|
->Contact |
string |
Kontaktní osoba |
|
->Country |
string |
Stát Číselník zemí |
|
->Email |
string |
E-mail |
|
->Name |
string |
Jméno |
|
->Name 2 |
string |
Jméno 2 |
|
->Phone |
string |
Telefon |
|
->Street |
string |
Ulice |
|
->ZipCode |
string |
PSČ |
|
->SpecDelivery |
|
Specifické údaje o dodání |
|
->ParcelShopCode |
string |
Kód ParcelShopu |
|
->SpecDelivDate |
DateTime |
Datum dodání zásilky |
|
->SpecDelivTimeFrom |
DateTime |
Čas dodání OD |
|
->SpecDelivTimeTo |
DateTime |
Čas dodání DO |
|
->SpecTakeDate |
DateTime |
Datum vyzvednutí zásilky |
|
->SpecTakeTimeFrom |
DateTime |
Čas vyzvednutí OD |
|
->SpecTakeTimeTo |
DateTime |
Čas vyzvednutí DO |
|
->TakeDate |
DateTime |
Datum vyzvednutí zásilky |
|
->Weight |
Decimal |
váha |
|
->WeightedDate |
DateTime |
Datum vážení |
|
->MyApiFlag |
|
SmartLabel / Sobotní doručení |
|
->Code |
string |
Dle číselníku |
|
->Value |
bool |
1/0 |
Příklad
XML struktury odpovědi metody GetPackages:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetPackagesResponse xmlns="http://myapi.ppl.cz/v1">
<GetPackagesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>B+WwnLWF7YDLdnYLkpD9TvMbBA....ld5mO6q6tb45bbq3JFvQ=</AuthToken>
<ResultData>
<MyApiPackageOut>
<BackDate i:nil="true"/>
<DelivDate i:nil="true"/>
<DelivPerson i:nil="true"/>
<DeliveryToKtm>false</DeliveryToKtm>
<DepInCode>09</DepInCode>
<DepInName>Olomouc</DepInName>
<DepOutCode>07</DepOutCode>
<DepOutName>Ostrava</DepOutName>
<DepoCode i:nil="true"/>
<HubDate i:nil="true"/>
<LoadDate i:nil="true"/>
<NotDelivDate i:nil="true"/>
<Note>TEST NEREAGOVAT</Note>
<OutDepDate i:nil="true"/>
<PackNumber>80912345678</PackNumber>
<PackProductType>BUSS</PackProductType>
<PackageStatuses/>
<PackagesExtNums>
<MyApiPackageExtNum>
<Code>B2CO</Code>
<ExtNumber>12345432100</ExtNumber>
</MyApiPackageExtNum>
</PackagesExtNums>
<PackagesServices>
<MyApiPackageOutService>
<Price i:nil="true"/>
<PriceCurrency i:nil="true"/>
<SvcCode>B2OC</SvcCode>
</MyApiPackageOutService>
<MyApiPackageOutService>
<Price i:nil="true"/>
<PriceCurrency i:nil="true"/>
<SvcCode>TOLL</SvcCode>
</MyApiPackageOutService>
<MyApiPackageOutService>
<Price i:nil="true"/>
<PriceCurrency i:nil="true"/>
<SvcCode>FUEL</SvcCode>
</MyApiPackageOutService>
</PackagesServices>
<PalletInfo>
<Collies/>
<ManipulationType i:nil="true"/>
<PEURCount i:nil="true"/>
<PackDesc i:nil="true"/>
<PickupCargoTypeCode i:nil="true"/>
<Volume i:nil="true"/>
</PalletInfo>
<PaymentInfo>
<BankAccount i:nil="true"/>
<BankCode i:nil="true"/>
<CanPayByCard i:nil="true"/>
<CodBankStatementDate i:nil="true"/>
<CodCurrency i:nil="true"/>
<CodPaidDate i:nil="true"/>
<CodPaymentAccDate i:nil="true"/>
<CodPrice i:nil="true"/>
<CodVarSym i:nil="true"/>
<IBAN i:nil="true"/>
<InvDate i:nil="true"/>
<InvNumber i:nil="true"/>
<PaidByCard>false</PaidByCard>
<SpecSymbol i:nil="true"/>
<Swift i:nil="true"/>
</PaymentInfo>
<Recipient>
<City>Krnov</City>
<Contact/>
<Country>CZ</Country>
<Email/>
<Name>Jméno Přijmení</Name>
<Name2/>
<Phone/>
<Street>Ulice 18</Street>
<ZipCode>79401</ZipCode>
</Recipient>
<Sender>
<City>Olomouc</City>
<Contact/>
<Country>CZ</Country>
<Email/>
<Name>název firmy</Name>
<Name2/>
<Phone/>
<Street>Ulice 20</Street>
<ZipCode>77900</ZipCode>
</Sender>
<SpecDelivery>
<ParcelShopCode i:nil="true"/>
<SpecDelivDate i:nil="true"/>
<SpecDelivTimeFrom i:nil="true"/>
<SpecDelivTimeTo i:nil="true"/>
<SpecTakeDate i:nil="true"/>
<SpecTakeTimeFrom i:nil="true"/>
<SpecTakeTimeTo i:nil="true"/>
</SpecDelivery>
<TakeDate i:nil="true"/>
<Weight>33.00</Weight>
<WeightVol i:nil="true"/>
<WeightedDate i:nil="true"/>
<Flags>
<MyApiFlag>
<Code>SL</Code>
<Value>1</Value>
</MyApiFlag>
</Flags>
</MyApiPackageOut>
</ResultData>
</GetPackagesResult>
</GetPackagesResponse>
</s:Body>
</s:Envelope>
Hodnoty atributů, které nejsou v databázi zadané, jsou nahrazeny v odpovědi na dotaz hodnotou "true" (v příkladu jsou zvýrazněny zelenou barvou).
Metoda CreateOrders je určena k vytvoření objednávky pro přepravu zásilky (pouze balíková platforma) z místa "A" do místa "B" kde není předem definováno číslo zásilky z číselné řady. Zásilka bude vyzvednuta kurýrem v místě "A" na základě vyplněných údajů objednávky.
Tabulka 11 - Popis vstupních atributů metody CreateOrders
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
|
|
Autentifikace |
|
|
-> AuthToken |
|
Ano |
Pro přihlášení je třeba zadat buď token nebo Login |
Autentifikační ticket |
|
|
-> CustId |
int |
|
ID zákazníka |
||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
Orders |
|
|
|
|
|
|
-> MyApiOrderIn |
|
|
|
|
|
|
-> OrdRefID |
string |
Délka: 100 |
Ano |
Pro každé volání musí být unikátní! |
Unikátní označení objednávky |
|
-> PackProductType |
int |
|
Ano |
|
Typ produktu - 1,9,11 |
|
-> CustRef |
string |
Délka: 40 |
Ne |
|
Zákaznicka reference |
|
-> CountPack |
int |
|
Ano |
Počet zásilek, musí být> 0; 50<. |
Počet zásilek k vyzvednutí (počet etiket k tisku)
– max 50 |
|
-> Note |
string |
Délka: 300 |
Ne |
|
Popis |
|
-> Email |
string |
Délka: 50 |
Ne |
|
E-mail Objednavatele (pro potvrzení) |
|
-> SendDate |
DateTime |
DateTime |
Ano |
YYYY-MM-DDThh:MM:SS |
Datum přepravy. Datum se rovná aktuálnímu datu nebo
datu v budoucnosti. |
|
-> SendTimeFrom |
DateTime |
DateTime |
Ne |
YYYY-MM-DDThh:MM:SS |
Preferovaný čas přepravy OD |
|
-> SendTimeTo |
DateTime |
DateTime |
Ne |
YYYY-MM-DDThh:MM:SS |
Preferovaný čas přepravy DO |
|
-> Sender |
|
|
|
|
|
|
-> City |
string |
Délka: 50 |
Ano |
|
Město |
|
-> Contact |
string |
Délka: 30 |
Ne |
|
Kontaktní osoba |
|
-> Country |
string |
Délka: 2 |
Ne |
|
Kód státu podle číselníku Číselník zemí - Pokud se jedná o mezinárodní zásilku (PackProductType =9, 11), pak country příjemce se nesmí
rovnat country odesílatele a zároveň je pak toto pole je povinné. - Pokud se jedná o tuzemskou zásilku (PackProductType = 1), pak country příjemce se musí rovnat
country odesílatele. |
|
-> Email |
string |
Délka: 50 |
Ne |
|
E-mail |
|
-> Name |
string |
Délka: 250 |
Ano |
|
Jméno |
|
-> Name2 |
string |
Délka: 250 |
Ne |
|
Jméno 2 |
|
-> Phone |
string |
Délka: 30 |
Ne |
|
Telefon |
|
-> Street |
string |
Délka: 30 |
Ano |
|
Ulice |
|
-> ZipCode |
string |
Délka: 10 |
Ano |
|
PSČ |
|
-> Recipient |
|
|
|
|
|
|
-> City |
string |
Délka: 50 |
Ano |
|
Město |
|
-> Contact |
string |
Délka: 300 |
Ne |
|
Kontaktní osoba |
|
-> Country |
string |
Délka: 2 |
Ne |
|
Kód státu podle číselníku Číselník zemí - Pokud se jedná o mezinárodní zásilku (PackProductType = CONN), pak country příjemce se nesmí
rovnat country odesílatele a zároveň je pak toto pole je povinné. - Pokud se jedná o tuzemskou zásilku (PackProductType = BUSS), pak country příjemce se musí
rovnat country odesílatele. |
|
-> Email |
string |
Délka: 50 |
Ne |
|
E-mail |
|
-> Name |
string |
Délka: 50 |
Ano |
|
Jméno |
|
-> Name2 |
string |
Délka: 50 |
Ne |
|
Jméno 2 |
|
-> Phone |
string |
Délka: 30 |
Ne |
|
Telefon |
|
-> Street |
string |
Délka: 50 |
Ano |
|
Ulice |
|
-> ZipCode |
string |
Délka: 10 |
Ano |
|
PSČ |
XML struktura dotazu pro metodu CreateOrders
*** PŘÍKLAD 1 (dotaz s vybranými minimálními atributy) ***
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header />
<soapenv:Body>
<v1:CreateOrders>
<v1:Auth>
<v1:AuthToken>e3mmlo7o+RAyrD2STiL5Nv.....AAugQAAGcAAAAa1ksyyjQ=</v1:AuthToken>
</v1:Auth>
<v1:Orders>
<v1:MyApiOrderIn>
<v1:OrdRefId>CO2015112707</v1:OrdRefId>
<v1:PackProductType>BUSS</v1:PackProductType>
<v1:CountPack>1</v1:CountPack>
<v1:Note>TEST</v1:Note>
<v1:SendDate>2020-01-26</v1:SendDate>
<v1:Sender>
<v1:City>Olomouc</v1:City>
<v1:Name>Tomáš Fuk</v1:Name>
<v1:Street>Uličná 30</v1:Street>
<v1:ZipCode>77900</v1:ZipCode>
</v1:Sender>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Name>Petr Příjemce</v1:Name>
<v1:Street>Na hraně 33</v1:Street>
<v1:ZipCode>77300</v1:ZipCode>
</v1:Recipient>
</v1:MyApiOrderIn>
</v1:Orders>
<v1:ReturnChannel />
</v1:CreateOrders>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody CreateOrders:
Po odeslání dotazu na metodu CreateOrders trvá zpracování dat určitou dobu, což může v některých případech trvat až 5 minut. Proto je třeba při zpětném ověření zapsaných dat metodou GetPackages počkat na zpracování.
Tabulka 12 - Popis výstupních atributů metody CreateOrders
|
Název elementu |
Typ |
Popis |
|
Code |
Int |
Návratová hodnota (hodnota není nula = chyba) |
|
Message |
String |
Popis návratové hodnoty (popis chyby) |
Příklad XML struktury odpovědi metody CreateOrders:
*** PŘÍKLAD 1 (odpověď v případě úspěšného zápisu) ***
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreateOrdersResponse xmlns="http://myapi.ppl.cz/v1">
<CreateOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>e3mmlo7o+RAyrD2STiL.....GneuBmTA5JTXZ0OKPx9qyyjQ=</AuthToken>
<ResultData>
<ItemResult>
<Code>0</Code>
<Message i:nil="true" />
</ItemResult>
</ResultData>
</CreateOrdersResult>
</CreateOrdersResponse>
</s:Body>
</s:Envelope>
Příklad XML struktury odpovědi metody CreateOrders:
*** PŘÍKLAD 2 (odpověď v případě chyby při zápisu) ***
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreateOrdersResponse xmlns="http://myapi.ppl.cz/v1">
<CreateOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>e3mmlo7o+RAyrD2STiL.....GneuBmTA5JTXZ0OKPx9qyyjQ=</AuthToken>
<ResultData>
<ItemResult>
<Code>1040</Code>
<Message>Unknown Package flag</Message>
</ItemResult>
</ResultData>
</CreateOrdersResult>
</CreateOrdersResponse>
</s:Body>
</s:Envelope>
Metoda CreatePackages je určena k odeslání údajů zásilek, pro které má klient přidělenou číselnou řadu a tiskne etikety. Metoda je omezena na 1000 zásilek na request.
Tabulka 13 - Popis vstupních atributů metody CreatePackages
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
Autentifikace |
|||
|
-> AuthToken |
Ano |
Pro přihlášení je třeba zadat buď token, nebo ID / UserName / Password |
Autentifikační ticket |
||
|
-> CustId |
int |
ID zákazníka |
|||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
int |
|
NE |
|
ID
integrátora – přiděluje PPL. Pokud data posílá integrátor, je parametr
povinný. |
|
|
Packages |
|
|
|||
|
-> MyApiPackageIn |
|
|
|||
|
-> PackNumber |
string |
Délka: 11 |
Ano |
Nesmí být vyplněno existující číslo (v minulosti). |
Číslo balíku, číslo vygenerované z číselné řady
zásilek zákazníka. |
|
-> PackProductType |
int |
Ano |
Dle číselníku produktů |
Typ produktu podle číselníku Číselník produktů Pokud PPT=45 Sender a Recipient jsou povinní! |
|
|
-> Note |
string |
Délka: 300 |
Ne |
|
Poznámka |
|
-> DepoCode |
string |
Délka: 2 |
Ne |
Validace podle Číselníku dep |
Kód vstupního depa. Fixní hodnota, přiřazuje depo zákazníka (pozn.: nemá NIC společného
s hodnotou z GetCitiesRouting). |
|
-> Sender |
Ne |
Pokud PPT=45 Sender a Recipient jsou povinní! |
|||
|
-> City |
string |
Délka: 50 |
Ano |
|
Město |
|
-> Contact |
string |
Délka: 300 |
Ne |
|
Kontaktní osoba. |
|
-> Country |
string |
Délka: 2 |
ANO |
1. Validace podle Číselník zemí 2. Pokud se jedná o mezinárodní zásilku (PackProductType = 9, 10,11,36,37,38), pak se země odesílatele
nesmí rovnat země příjemce a zároveň je pak toto pole povinné. 3. Pokud se jedná o tuzemskou zásilku (PackProductType = 1,2,7,8,13,14,15), pak se
země odesílatele musí rovnat země příjemce. |
Kód země podle číselníku Číselník zemí |
|
-> Email |
string |
Délka: 50 |
Ne |
|
Vyplněný kontaktní
údaj výrazně zvyšuje úspěšnost doručení |
|
-> Name |
string |
Délka: 50 |
Ano |
|
Jméno |
|
-> Name2 |
string |
Délka: 50 |
Ne |
|
Jméno 2 |
|
-> Phone |
string |
Délka: 30 |
Ne |
|
Vyplněný kontaktní
údaj výrazně zvyšuje úspěšnost doručení |
|
-> Street |
string |
Délka: 50 |
Ano |
|
Ulice |
|
-> ZipCode |
string |
Délka: 10 |
Ano |
|
PSČ |
|
-> Recipient |
|
|
|||
|
-> City |
string |
Délka: 50 |
Ano |
|
Město |
|
-> Contact |
string |
Délka: 300 |
Ne |
|
Kontaktní osoba V případě zásilky na ParcelShop, zde uvádět kontakt příjemce (jméno nebo
firma) nebo duplikovat <Name> |
|
-> Country |
string |
Délka: 2 |
ANO |
1. Validace podle Číselník zemí 2. Pokud se jedná o mezinárodní zásilku (PackProductType = 9, 10,11,36,37,38), pak se země odesílatele nesmí rovnat země příjemce a
zároveň je pak toto pole povinné. 3. Pokud se jedná o tuzemskou zásilku (PackProductType = 1,2,7,8,13,14), pak se
země odesílatele musí rovnat země příjemce. |
Kód země podle číselníku Číselník zemí |
|
-> Email |
string |
Délka: 50 |
Ne |
|
Vyplněný kontaktní
údaj výrazně zvyšuje úspěšnost doručení |
|
-> Name |
string |
Délka: 50 |
Ano |
|
Jméno |
|
-> Name2 |
string |
Délka: 50 |
Ne |
|
Jméno 2 |
|
-> Phone |
string |
Délka: 30 |
Ne |
Telefon |
Vyplněný kontaktní
údaj výrazně zvyšuje úspěšnost doručení |
|
-> Street |
string |
Délka: 50 |
Ano |
|
Ulice |
|
-> ZipCode |
string |
Délka: 10 |
Ano |
Irsko – Město kopírujte do PSČ; GB dle vzoru: A9 9AA |
PSČ |
|
-> SpecDelivery |
|
|
|||
|
-> ParcelShopCode |
string |
Délka: 50 |
Ne |
1. Pouze pro balíkové zásilky 2. PackProductType pouze
13,14, 36, 37, 46, 47, 48, 49 2. Validace proti seznamu, který vrací metoda GetParcelShops |
Kód ParcelShopu |
|
-> PaymentInfo |
|
Platební informace,
relevantní pouze pro dobírkové produkty. |
|||
|
-> BankAccount |
string |
Délka: 10 |
Ne |
1. BankAccount
pokud je vyplněno, pak musí být vyplněno i pole BankCode. 2. Pokud je vyplněno BankAccount
a BankCode, pak nemůže být vyplněn IBAN a SWIFT. |
Číslo bankovního účtu |
|
-> BankCode |
string |
Délka: 4 |
Ne |
1. BankCode
pokud je vyplněn, pak musí být vyplněno i pole BankAccount. 2. Pokud je vyplněno BankAccount
a BankCode, pak nemůže být vyplneén
IBAN a SWIFT. 3. Validace podle Číselník bankovních kódů |
Kód banky podle číselníku Číselník |
|
-> CodCurrency |
string |
Délka: 3 |
Ne |
1. Pokud je vyplněno CodCurrency,
pak musí být vyplněno i CodPrice. 2. Validace podle Číselník měn |
Měna dobírky podle číselníku Číselník
povolených měn |
|
-> CodPrice |
decimal |
Délka: 12.4 |
Ne |
1. Pokud je CodPrice
vyplněné, pak musí být vyplněno i CodCurrency. 2. Částka nesmí být záporná. 3. Částka může být maximálně Limitace viz Produktové podmínky |
Částka dobírky. Částka je oddělena tečkou. Pouze kladné číslo. Pokud je v CZK a země CZ,
pak zaokrouhlená na celé částky. |
|
-> CodVarSym |
long |
Délka: 30 |
Ne |
Omezení na 0-10 čísel. Pokud jsou vyplněny elementy CodCurrency
nebo CodPrice, pak CodVarSym
musí být vyplněn. |
Variabilní symbol dobírky. POUZE čísla |
|
-> IBAN |
string |
Délka: 50 |
Ne |
1. IBAN pokud je vyplněn,
pak musí být vyplněno i pole SWIFT. 2. Pokud je vyplněno IBAN a SWIFT, pak nemůže být
vyplněny BankAccount a BankCode. |
IBAN |
|
-> InsurCurrency |
string |
Délka: 3 |
Ne |
1. Pokud je InsurCurrency
vyplněné, pak musí být vyplněno i InsurPrice. 2. Validace pouze CZK |
Připojištění může být pouze v rámci naší národní
měny – CZK |
|
-> InsurPrice |
decimal |
Délka: 12,4 |
Ne |
1. Pokud je InsurPrice
vyplněné, pak musí být vyplněno i InsurCurrency. 2. Částka nesmí být záporná ani nulová 3. Částka může být maximálně 1 000 000, - CZK. |
Částka připojištění. Zadává se jen připojištění,
standardní pojištění zásilky se zde neuvádí (automaticky do hodnoty 50.000 u
balíku, 900.000 PPLSprint, 100.000 Balíky do
zahraničí. |
|
-> SpecSymbol |
string |
Délka: 6 |
Ne |
Omezení na 0-10 čísel |
Specifický symbol |
|
-> Swift |
string |
Délka: 50 |
Ne |
1. SWIFT, pokud je vyplněno, pak musí být vyplněno i
pole IBAN. 2. Pokud je vyplněno IBAN a SWIFT, pak nemůže být
vyplněny BankAccount a BankCode. 3. Validace podle Číselník SWIFT |
SWIFT |
|
-> PackagesExtNums |
|
|
|||
|
-> MyApiPackageExtNum |
Musí být
vyplněno Code i ExtNumber
zároveň, nelze vyplnit pouze jedno z těchto polí. Buď obě, nebo žádné. |
|
|||
|
-> Code |
string |
Délka: 4 |
Ano |
Validace podle Číselník typ externích čísel |
Kód typu externího čísla podle číselníku Číselník typu externích čísel |
|
-> ExtNumber |
string |
Délka: 50 |
Ano |
|
Externí číslo zásilky |
|
-> PackageServices |
|
|
Ne |
|
Služby k zásilce |
|
-> MyApiPackageInServices |
|
|
|
|
|
|
-> SvcCode |
string |
Délka: 4 |
Ano |
- Služby vázány na daný produkt viz Číselník služeb. |
Kód služby. Validace podle Číselník služeb |
|
-> Flags |
|
|
|||
|
-> MyApiFlag |
|
|
|||
|
-> Code |
string |
Length: 3 |
Yes |
Typ tisknuté etikety (např. SL/CL) viz číselník typů etiket. |
|
|
-> Value |
bool |
Yes |
|
Flag true / false |
|
|
-> PackageSet |
|
|
|
|
|
|
-> MasterPackNumber |
String |
|
Yes |
|
V případě
sady balíků - číslo nosného balíku/nadřazeného
(první ze sady nebo výběrčí dobírky). |
|
-> PackageInSetNr |
int |
|
Ano |
|
Pořadí balíku |
|
-> PackagesInSet |
int |
|
Ano |
Validace – Není větší> PackageInSet |
Počet balíků v sadě |
|
-> WeightedPackageInfo |
Pouze pro balíkové produkty |
Pouze PackProductType 1,2,7,8,9,10,13,14,36,37,38 |
|||
|
-> Weight |
decimal |
Délka: 9,2 |
Ano |
Váha musí >= 0 |
Váha zásilky, které zvážil klient. Pouze pro
balíkovou platformu! |
|
-> Routes |
|
Informace
o směrech k vážené zásilce – návaznost na GetCitiesRouting |
|||
|
-> Route |
|
Směr |
|||
|
-> RouteType |
string |
Délka: 6 |
Ano |
Pouze u vážených zásilek |
Validace podle Číselník typu směrů (RouteType „IN“ dodá PPL) |
|
-> RouteCode |
string |
Délka: 50 |
Ano |
Omezení na 5 čísel |
Kód směru podle číselníku směrů |
|
|
|
|
|
|
|
|
-> AddressForService |
|
|
|
|
|
|
-> ServiceAddressType |
|
|
|
|
Typ adresy viz číselník číselník
„Číselník typů adres“ |
|
-> BackPackNumber |
string |
Délka: 11 |
Ano |
NESMÍ
být použito jedno číslo vícekrát! |
Číslo balíku typu
45 PPL Return CZ nebo pro import Exportní produkt (např. 2xxxxxxxxxx) |
|
-> PackNrRetConnect |
string |
|
Ne |
NESMÍ být použito jedno číslo vícekrát! |
Return Shipment Number for Return Connect (JJD..) |
|
-> Recipient |
|
|
|
|
|
|
-> City |
string |
Délka: 50 |
Ano |
|
Město |
|
-> Contact |
string |
Délka: 300 |
Ne |
|
Kontaktní osoba |
|
-> Country |
string |
Délka: 2 |
ANO |
|
Pouze CZ |
|
-> Email |
string |
Délka: 50 |
Ne |
|
E-mail |
|
-> Name |
string |
Délka: 50 |
Ano |
|
Jméno |
|
-> Name2 |
string |
Délka: 50 |
Ne |
|
Jméno 2 |
|
-> Phone |
string |
Délka: 30 |
Ne |
|
Telefon |
|
-> Street |
string |
Délka: 50 |
Ano |
|
Ulice |
|
-> ZipCode |
string |
Délka: 10 |
Ano |
|
PSČ |
|
-> Flags |
|
|
|
|
|
|
-> MyApiFlag |
|
|
|
|
|
|
-> Code |
string |
Length: 3 |
Yes |
Typ tisknuté etikety (např. SL) viz číselník typů etiket. |
|
|
-> Value |
bool |
|
Yes |
|
Flag true / false |
XML struktura dotazu pro metodu CreatePackages
*** PŘÍKLAD 1 (dotaz s minimálním počtem atributů) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages >
<v1:Auth>
<v1:AuthToken>e3mmlo7o+RAyrD2STiL5Nv.....AAugQAAGcAAAAa1ksyyjQ=</v1:AuthToken>
</v1:Auth>
<v1:CustomerUniqueImportId>CUID1511001</v1:CustomerUniqueImportId>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>80912345678</v1:PackNumber>
<v1:PackProductType>BUSS</v1:PackProductType>
<v1:Note></v1:Note>
<v1:DepoCode></v1:DepoCode>
<v1:Sender>
<v1:City>Olomouc</v1:City>
<v1:Contact></v1:Contact>
<v1:Country></v1:Country>
<v1:Email></v1:Email>
<v1:Name>nazev odesilatele</v1:Name>
<v1:Name2></v1:Name2>
<v1:Phone></v1:Phone>
<v1:Street>ulice</v1:Street>
<v1:ZipCode>77300</v1:ZipCode>
</v1:Sender>
<v1:Recipient>
<v1:City>Praha</v1:City>
<v1:Contact></v1:Contact>
<v1:Country>CZ</v1:Country>
<v1:Email></v1:Email>
<v1:Name>nazev prijemce</v1:Name>
<v1:Name2></v1:Name2>
<v1:Phone></v1:Phone>
<v1:Street>ulice 26</v1:Street>
<v1:ZipCode>15500</v1:ZipCode>
</v1:Recipient>
<v1:PackagesExtNums>
<v1:MyApiPackageExtNum>
<v1:Code>B2CO</v1:Code>
<v1:ExtNumber>20151127001</v1:ExtNumber>
</v1:MyApiPackageExtNum>
</v1:PackagesExtNums>
</v1:MyApiPackageIn>
</v1:Packages>
<v1:ReturnChannel/>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody CreatePackages:
Po
odeslání dotazu na metodu CreatePackages může
zpracování dat trvat určitou dobu, což může být v některých případech až 5
minut. Proto je třeba při zpětném ověření zapsaných dat metodou GetPackages, počkat na zpracování.
Tabulka 14 - Popis výstupních atributů metody CreatePackages
|
Název elementu |
Typ |
Popis |
|
Code |
Int |
Návratová hodnota (hodnota není nula = chyba) |
|
Message |
String |
Popis návratové hodnoty (popis chyby) |
Příklad XML struktury odpovědi metody CreatePackages:
*** PŘÍKLAD 1 (odpověď v případě úspěšného zápisu) ***
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreatePackagesResponse xmlns="http://myapi.ppl.cz/v1">
<CreatePackagesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>e3mmlo7o+RAyrD2STiL.....GneuBmTA5JTXZ0OKPx9qyyjQ=</AuthToken>
<ResultData>
<ItemResult>
<Code>0</Code>
<ItemKey>80912345678</ItemKey>
<Message i:nil="true" />
</ItemResult>
</ResultData>
</CreatePackagesResult>
</CreatePackagesResponse>
</s:Body>
</s:Envelope>
Příklad XML struktury odpovědi metody CreatePackages:
<?xml version="1.0"
encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreatePackagesResponse
xmlns="http://myapi.ppl.cz/v1">
<CreatePackagesResult
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>e3mmlo7o+RAyrD2STiL.....GneuBmTA5JTXZ0OKPx9qyyjQ=</AuthToken>
<ResultData>
<ItemResult>
<Code>1040</Code>
<ItemKey>80912345678</ItemKey>
<Message>Unknown Package flag</Message>
</ItemResult>
</ResultData>
</CreatePackagesResult>
</CreatePackagesResponse>
</s:Body>
</s:Envelope>
Metoda CreatePickupOrders je určena k zaslání objednávek svozu zásilek (vyzvednutí označených etiket na svozové adrese zákazníka).
Tabulka 15 - Popis vstupních atributů metody CreatePickupOrders
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
|
|
|
Autentifikace |
|
-> AuthToken |
|
|
Ano |
Pro přihlášení je třeba zadat buď token nebo Login |
Autentifikační ticket |
|
-> CustId |
int |
|
ID zákazníka |
||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
Orders |
|
|
|
|
|
|
-> MyApiPickupOrderIn |
|
|
|
|
|
|
-> OrdRefId |
string |
Délka: 100 |
Ano |
|
Unikátní označení objednávky (nemůže být použito 2x
jedno a to stejné) |
|
-> CustRef |
string |
Délka: 40 |
Ne |
|
Zákaznická reference |
|
-> CountPack |
int |
|
Ano |
Počet zásilek musí být >
0 |
Počet zásilek |
|
-> Note |
string |
Délka: 300 |
Ne |
|
Poznámka |
|
-> Email |
string |
Délka: 50 |
Ne |
|
E-mail |
|
-> SendDate |
DateTime |
YYYY-MM-DD |
Ano |
|
Datum přepravy. Datum se rovná aktuálnímu datu nebo
datu v budoucnosti. |
|
-> SendTimeFrom |
DateTime |
|
Ne |
YYYY-MM-DDThh:mm:ss |
Preferovaný čas přepravy OD |
|
-> SendTimeTo |
DateTime |
|
Ne |
YYYY-MM-DDThh:mm:ss |
Preferovaný čas přepravy DO |
|
-> Sender |
|
|
|
|
|
|
-> City |
string |
Délka: 50 |
Ano |
|
Město |
|
-> Contact |
string |
Délka: 30 |
Ne |
|
Kontaktní osoba |
|
-> Country |
string |
Délka: 2 |
Ne |
Validace podle Číselník státu |
Kód země podle číselníku Číselník zemí |
|
-> Email |
string |
Délka: 50 |
Ne |
|
E-mail |
|
-> Name |
string |
Délka: 250 |
Ano |
|
Jméno |
|
-> Name2 |
string |
Délka: 250 |
Ne |
|
Jméno 2 |
|
-> Phone |
string |
Délka: 30 |
Ne |
|
Telefon |
|
-> Street |
string |
Délka: 30 |
Ano |
|
Ulice |
|
-> ZipCode |
string |
Délka: 10 |
Ano |
|
PSČ |
XML struktura dotazu pro metodu CreatePickupOrders
*** PŘÍKLAD 1 (dotaz s minimálním
počtem atributů) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:CreatePickupOrders>
<v1:Auth>
<v1:CustId>123456</v1:CustId>
<v1:Password>XY12324654</v1:Password>
<v1:UserName>XY12324654</v1:UserName>
</v1:Auth>
<v1:Orders>
<v1:MyApiPickupOrderIn>
<v1:OrdRefId>a1</v1:OrdRefId>
<v1:CustRef>ref</v1:CustRef>
<v1:CountPack>1</v1:CountPack>
<v1:Email>jfnukal@ppl.cz</v1:Email>
<v1:SendDate>2017-12-06</v1:SendDate>
<v1:Sender>
<v1:City>Ostrava</v1:City>
<v1:Country>CZ</v1:Country>
<v1:Name>jmeno</v1:Name>
<v1:Street>Ulice</v1:Street>
<v1:ZipCode>70999</v1:ZipCode>
</v1:Sender>
</v1:MyApiPickupOrderIn>
</v1:Orders>
<v1:ReturnChannel>
</v1:ReturnChannel>
</v1:CreatePickupOrders>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody CreatePickupOrders:
Tabulka 16 - Popis výstupních atributů metody CreatePickupOrders
|
Název elementu |
Typ |
Popis |
|
Code |
Int |
Návratová hodnota (hodnota nerovná nule = chyba) |
|
Message |
String |
Popis návratové hodnoty (popis chyby) |
Příklad XML struktury odpovědi metody CreatePickupOrders:
*** PŘÍKLAD 1 (odpověď v
případě úspěšného zápisu) ***
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreatePickupOrdersResponse xmlns="http://myapi.ppl.cz/v1">
<CreatePickupOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>e3mmlo7o+RAyrD2STiL.....GneuBmTA5JTXZ0OKPx9qyyjQ=</AuthToken>
<ResultData>
<ItemResult>
<Code>0</Code>
<Message i:nil="true" />
</ItemResult>
</ResultData>
</CreatePickupOrdersResult>
</CreatePickupOrdersResponse>
</s:Body>
</s:Envelope>
Příklad XML struktury odpovědi metody CreatePickupOrders:
*** PŘÍKLAD 2 (odpověď v
případě chyby při zápisu) ***
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreatePickupOrdersResponse xmlns="http://myapi.ppl.cz/v1">
<CreatePickupOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>e3mmlo7o+RAyrD2STiL.....GneuBmTA5JTXZ0OKPx9qyyjQ=</AuthToken>
<ResultData>
<ItemResult>
<Code>1040</Code>
<Message>Unknown Package flag</Message>
</ItemResult>
</ResultData>
</CreatePickupOrdersResult>
</CreatePickupOrdersResponse>
</s:Body>
</s:Envelope>
Metoda vrací
číselné řady pro jednotlivé produkty. Základem metody je automatizovat a dodávat
všechny typy číselných řad. Zákazník, tak bude moci, v případě, že mu
číselná řada bude docházet, požádat o nový rozsah daného typu. Odbourá se tak
chyba lidského faktoru a možnosti dodání špatné číselné řady. Rychlejší
odbavení takových požadavků.
Tabulka 17 - Popis vstupních atributů metody GetNumberRange
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
Autentifikace |
|||
|
-> AuthToken |
Ano |
Pro přihlášení je třeba zadat buď token, nebo ID / Username / Password |
Autentifikační ticket |
||
|
-> CustId |
int |
ID zákazníka |
|||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
-> NumberRanges |
|
|
|||
|
-> NumberRangeRequest |
|
|
|
|
|
|
-> PackProductType |
string |
Ano |
|
Typ produktu podle číselníku Číselník produktů |
|
|
-> Quantity |
Int |
|
Ano |
Počet musí být > 99 |
Počet žádaných čísel 100 – 50.000 max |
|
-> IntegrId |
int |
|
NE |
|
ID integrátora – přiděluje PPL. Pokud je přes
integrátora, je povinný. |
XML struktura dotazu pro metodu GetNumberRange
*** PŘÍKLAD 1 (dotaz s vybranými minimálními atributy – požadavek, na více typů) ***
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header/>
<soapenv:Body>
<v1:GetNumberRange>
<v1:Auth>
<v1:CustId>123456</v1:CustId>
<v1:Password>AA112233</v1:Password>
<v1:UserName>AA112233</v1:UserName>
</v1:Auth>
<v1:NumberRanges>
<v1:NumberRangeRequest>
<v1:PackProductType>PRIV</v1:PackProductType>
<v1:Quantity>100</v1:Quantity>
</v1:NumberRangeRequest>
<v1:NumberRangeRequest>
<v1:PackProductType>PRID</v1:PackProductType>
<v1:Quantity>100</v1:Quantity>
</v1:NumberRangeRequest>
</v1:NumberRanges>
</v1:GetNumberRange>
</soapenv:Body>
</soapenv:Envelope>
Tabulka 18 - Popis výstupních atributů metody GetNumberRange
|
Název elementu |
Datový typ |
Popis |
|
-> PackProductType |
string |
Typ produktu podle číselníku Číselník produktů |
|
-> Name |
string |
Název daného
produktu – viz Číselník produktů |
|
-> Quantity |
int |
Počet
žádaných čísel 100 – 50.000 |
|
-> From |
string |
Vrací hodnotu od (11 čísel – balíková platforma) |
|
-> To |
string |
Vrací hodnotu do (11 čísel – balíková
platforma) |
Příklad
XML struktury odpovědi metody GetNumberRange:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
< GetNumberRangeResponse
xmlns="http://myapi.ppl.cz/v1">
< GetNumberRangResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>B+WdnYLkpD9TvMbBA....ld5mO6q6tb45bbq3JFvQ=</AuthToken>
<ResultData>
<NumberRange>
<PackProductType>BUSS</PackProductType >
<Name>PPL Parcel CZ Business</Name
>
<Quantity>1000</Quantity >
<From>80010000001</From >
<To>80010001000</To >
<ErrorCode>0</ErrorCode>
<ErrorMessage i:nil="true"/>
</NumberRange>
<NumberRange>
<PackProductType>PRID</PackProductType >
<Name>PPL Parcel CZ Private</Name >
<Quantity>500</Quantity >
<From>40010000001</From >
<To>40010001000</To >
<ErrorCode>0</ErrorCode>
<ErrorMessage i:nil="true"/>
</NumberRange>
<NumberRange>
<PackProductType>PRID</PackProductType >
<Name>PPL Parcel CZ Private
- Dobírka</Name >
<Quantity>500</Quantity>
<From>40090000001</From >
<To>40090001000</To >
</NumberRange >
</ResultData>
</GetPackagesResult>
</GetPackagesResponse>
</s:Body>
</s:Envelope>
Metoda vrací volné číselné řady pro
jednotlivé produkty. Základem
metody je získat informace k volným číselným řadám od 100 čísel a výše,
aby mohlo dojít ke kompletnímu vyčerpávání číselných řad. Základní informace je
o všech číselných řadách, rozšířená filtrace na úrovni produktu.
Table 19 - Popis vstupních atributů metody GetFreeRangeInfo
|
Název elementu |
Datový typ |
Datový formát |
Povinný |
Validace |
Popis |
|
Auth |
|
Autentifikace |
|||
|
-> AuthToken |
Ano |
Pro
přihlášení je třeba zadat buď token, nebo ID / Username
/ Password |
Autentifikační
ticket |
||
|
-> CustId |
int |
ID zákazníka |
|||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací
jméno |
||
|
-> PptId |
string |
Ne |
PackProductType |
Dle číselníku
produktů |
|
|
-> IntegrId |
Int |
|
Ne |
|
ID integrátora – filtrace etiket pouze daného ID |
XML struktura dotazu pro metodu GetFreeRangeInfo
*** PŘÍKLAD 1 (dotaz s vybranými minimálními atributy) ***
<?xml
version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header
/>
<soapenv:Body>
<v1:GetFreeRangeInfo>
<v1:Auth>
<v1:CustId>123456</v1:CustId>
<v1:Password>
AA112233</v1:Password>
<v1:UserName>
AA112233</v1:UserName>
</v1:Auth>
</v1:GetFreeRangeInfo>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody GetFreeRangeInfo
Tabulka 20 - Popis výstupních atributů metody GetNumberRange
|
Název elementu |
Datový typ |
Popis |
|
-> PackProductName |
string |
Typ
produktu podle číselníku Číselník produktů |
|
-> PackProductType |
string |
Typ
produktu podle číselníku Číselník produktů |
|
-> DocumentBack |
boolean |
Dokumenty zpět - true/false |
|
-> BackPackNumber |
boolean |
Zpětná
zásilka – true/false |
|
-> Quantity |
||
|
-> From |
string |
Vrací
hodnotu od (11 čísel – balíková platforma) |
|
-> To |
string |
Vrací
hodnotu do (11 čísel – balíková platforma) |
|
-> Available |
int |
Vrací
počet volných čísel |
|
-> CreatedType |
|
|
|
-> CreatedByName |
string |
myAPI-GetNumberRange nebo PPL User |
|
-> CreatedDate |
dateTime |
Datum
vytvoření |
Příklad XML struktury odpovědi
metody GetFreeRangeInfo:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetFreeRangeInfoResponse xmlns="http://myapi.ppl.cz/v1">
<GetFreeRangeInfoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AuthToken>RUFBQUF…….GlmM2lHcTlzbnZjaUZJU0djadyTWlJZFZsWFVVRkdBSjJ3RnpnX1hqdzI=</AuthToken>
<ResultData>
<GetFreeNumberRangesData>
<PackProductName>PPL Parcel CZ Business</PackProductName>
<PackProductType>BUSS</PackProductType>
<DocumentBack>false</DocumentBack>
<BackPackNumber>false</BackPackNumber>
<Quantity>
<From>80900000001</From>
<To>80900000010</To>
<Available>10</Available>
</Quantity>
<CreatedType>
<CreatedByName>myAPI-GetNumberRange</CreatedByName>
<CreatedDate>2020-09-30T09:14:11.41</CreatedDate>
</CreatedType>
</GetFreeNumberRangesData>
</ResultData>
</GetFreeRangeInfoResult>
</GetFreeRangeInfoResponse>
</s:Body>
</s:Envelope>
Metoda GetOrders je určena klientovi pro vyhledávání objednávek a detailních údajů, jako například stav objednávky. Zákazník se dotazuje například rozsahem datumu, konkrétním číslem objednávky.
Tabulka 21 - Popis vstupních atributů metody GetOrders
|
Název
elementu |
Datový
typ |
Datový
formát |
Povinný |
Validace |
Popis |
|
Auth |
|
|
|
Autentifikace |
|
|
-> AuthToken |
|
Ano |
Pro přihlášení je třeba zadat buď token nebo Login |
Autentifikační ticket |
|
|
-> CustId |
int |
|
ID zákazníka |
||
|
-> Password |
string |
Délka: 32 |
Heslo |
||
|
-> UserName |
string |
Délka: 32 |
Přihlašovací jméno |
||
|
->Filter |
|
|
|
|
|
|
-> CustRefs |
string |
Délka: 40 |
Ne |
|
Zákaznická reference |
|
-> DateFrom |
DateTime |
YYYY-MM-DD |
Ne |
|
Datum OD |
|
-> DateTo |
DateTime |
YYYY-MM-DD |
Ne |
|
Datum DO |
|
-> OrderIds |
ArrayOfint |
|
Ne |
|
|
|
-> OrderNumbers |
ArrayOfstring |
|
Ne |
|
|
|
-> OrderRefs |
ArrayOfstring |
Ne |
|
||
|
-> OrderState |
|
|
Ne |
|
Dle číselníku Číselník stavů zásilek |
|
-> PackNumbers |
ArrayOfstring |
Délka: 11 |
Ne |
|
Číslo zásilky |
|
-> PackProductType |
string |
Ne |
PPT 1,11,36 |
PPT 1,11,36 |
|
|
-> SendDate |
dateTime |
|
Ne |
|
Datum objednání přepravy |
XML struktura dotazu pro metodu GetOrders
*** PŘÍKLAD 1 (dotaz s vybranými minimálními atributy) ***
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1">
<soapenv:Header />
<soapenv:Body>
<v1:GetOrders>
<v1:Auth>
<v1:AuthToken>e3mmlo7o+RAyrD2STiL5Nv.....AAugQAAGcAAAAa1ksyyjQ=</v1:AuthToken>
</v1:Auth>
<v1:Filter>
<v1:OrderState>PickedUp</v1:OrderState>
</v1:Filter>
</v1:GetOrders>
</soapenv:Body>
</soapenv:Envelope>
Odpověď metody GetOrders:
Při zpětném ověření zapsaných dat metodou GetOrders počkat na zpracování.
Tabulka 22 - Popis výstupních atributů metody GetOrders
|
Název elementu |
Typ |
Popis |
|
->MyApiOrderOut |
||
|
-> CountPack |
int |
Počet zásilek zadaných objednavatelem |
|
-> CustRef |
string |
Zákaznická reference |
|
-> DelivDateTime |
DateTime |
Datum doručení |
|
-> Email |
string |
E-mail Objednavatele |
|
-> Note |
string |
Poznámka |
|
-> OrderNumber |
string |
Číslo objednávky |
|
-> OrderRefId |
string |
Referenční číslo objednávky |
|
-> OrderState |
Dle číselníku Číselník
stavů objednávek |
|
|
-> OrderStateDetail |
string |
Detail stavu objednávky |
|
-> OrderStateDetailName |
string |
Název stavu objednávky |
|
-> PackNumbers |
ArrayOfstring |
Čísla balíků |
|
-> PackProductType |
string |
Číslo produktu |
|
-> RealCountPack |
int |
Vyzvednuto balíků |
|
-> RealSendDate |
dateTime |
Datum vyzvednutí zásilek |
|
-> Recipient |
|
Příjemce |
|
->City |
string |
Město |
|
->Contact |
string |
Kontaktní osoba |
|
->Country |
string |
Stát Číselník zemí |
|
->Email |
string |
E-mail |
|
->Name |
string |
Jméno |
|
->Name 2 |
string |
Jméno 2 |
|
->Phone |
string |
Telefon |
|
->Street |
string |
Ulice |
|
->ZipCode |
string |
PSČ |
|
-> SendDate |
dateTime |
Datum vyzvednutí zadané objednavatelem |
|
-> Sender |
|
Odesílatel |
|
->City |
string |
Město |
|
->Contact |
string |
Kontaktní osoba |
|
->Country |
string |
Stát Číselník zemí |
|
->Email |
string |
E-mail |
|
->Name |
string |
Jméno |
|
->Name 2 |
string |
Jméno 2 |
|
->Phone |
string |
Telefon |
|
->Street |
string |
Ulice |
|
->ZipCode |
string |
PSČ |
Možnost stornovat fyzicky neposlaný balík.
|
Název elementu |
Typ |
Popis |
|
->CancelPackage |
||
|
-> PackNumber |
strint |
Číslo balíku |
Odpověď metody CancelPackage:
|
Název elementu |
Typ |
Popis |
|
->CancelPackageResult |
||
|
-> Code |
strint |
0 = OK |
Metoda slouží k získávání novinek, informací, plánované odstávky a další důležité informace vztahující se k (nejen) myAPI.
|
Název elementu |
Typ |
Popis |
|
->GetVersionInformation |
||
|
-> language |
strint |
Zvolený jazyk - cs/en (default CS) |
Odpověď metody GetVersionInformation:
|
Název elementu |
Typ |
Popis |
|
->GetVersionInformationResult |
||
|
-> Language |
string |
Zvolený jazyk |
|
-> Title |
string |
Název |
|
-> Description |
string |
Popis |
|
-> InformationType |
string |
Typ informace (Novinka…) |
|
-> Priority |
int |
Priorita |
|
-> Version |
string |
Verze (V které verzi bylo nasazeno) |
|
-> ValidFrom |
dateTime |
Platnost od |
|
-> ValidTo |
dateTime |
Platnost do |
|
-> Created |
dateTime |
Vytvořeno |
|
Kód |
Popis |
Kód |
Popis |
|
0 |
Loaded successfully |
1028 |
Unknown insurance currency |
|
1000 |
Invalid or missing Package Number |
1029 |
Unknown package service |
|
1001 |
Unknown Product Type |
1030 |
Unknown external number |
|
1002 |
Bad sender address |
1031 |
Invalid country in sender address |
|
1003 |
Bad recipient address |
1032 |
Invalid country in
recipient address |
|
1004 |
Invalid COD variable symbol |
1033 |
Invalid informations about weighted packages |
|
1005 |
Invalid special symbol |
1034 |
Unknown routes |
|
1006 |
COD price and COD currency not filled both |
1035 |
Invalid package weight |
|
1007 |
COD negative price |
1036 |
Saturday delivery filled and saturday route not or vice versa |
|
1008 |
Invalid bank informations - filled bank account/code and also IBAN/SWIFT |
1037 |
Missing input destination |
|
1009 |
Bank account and bank code must be filled
both |
1038 |
Missing output destination |
|
1010 |
IBAN and SWIFT must be filled
both |
1039 |
Filled route type in and not route type out or vice versa.
Two times filled route type out or route type in. |
|
1011 |
Unknown bank code |
1040 |
Unknown Package flag |
|
1012 |
Unknown SWIFT code |
2001 |
Bad sender address |
|
1013 |
Filled COD informations for nonCOD product |
2002 |
Bad count of packages |
|
1023 |
Unknown ParcelShop code |
2005 |
Invalid country in sender address |
|
1024 |
Invalid package weight |
3001 |
Bad recipient address |
|
1025 |
Insurance price and currency must be filled both |
3002 |
Bad sender address |
|
1026 |
Insurance negative price |
3003 |
Bad count of packages |
|
1027 |
Unknown COD currency |
3004 |
Unknown product type for package |
|
|
|
3005 |
Invalid country in sender address |
|
|
|
3006 |
Invalid country in
recipient address |
|
Product Type ISO |
PptID (old) |
Name |
COD |
Poznámka |
|
BUSS |
1 |
PPL Parcel CZ Business |
0 |
|
|
BUSD |
2 |
PPL Parcel CZ Business – dobírka |
1 |
|
|
DOPO |
7 |
PPL Parcel CZ Dopolední balík |
0 |
Pouze do vybraných
měst, viz. GetCitiesRouting |
|
DOPD |
8 |
PPL Parcel CZ Dopolední balík – dobírka |
1 |
Pouze do vybraných
měst, viz. GetCitiesRouting |
|
COPL |
9 |
PPL Parcel Business Europe
|
0 |
Pouze
do povolených zemích. Aktuální informace na www.ppl.cz nebo obchodního
zástupce PPL |
|
BUED |
10 |
PPL Parcel Business Europe
– dobírka |
1 |
Zatím nelze |
|
IMPO |
11 |
PPL Parcel Import |
0 |
Pouze u CreatOrders |
|
PRIV |
13 |
PPL Parcel CZ Private |
0 |
Možnost služby
Garantované večerní doručení; PPL Return
CZ |
|
PRID |
14 |
PPL Parcel CZ Private –
dobírka |
1 |
Možnost služby
Garantované večerní doručení; PPL Return
CZ |
|
CONN |
36 |
PPL Parcel Connect |
0 |
Pouze
do povolených zemích. Aktuální informace na www.ppl.cz nebo obchodního
zástupce PPL |
|
COND |
37 |
PPL Parcel Connect –
Dobírka |
1 |
Pouze
do povolených zemích. Aktuální informace na www.ppl.cz nebo obchodního
zástupce PPL |
|
RETD |
45 |
PPL Parcel Return CZ |
0 |
Buď s produktem
PPL Parcel CZ Privat (+ dobírka) 13,14 (inbox solution)
nebo jako samostatný
produkt. |
|
SMAR |
PPL Parcel
CZ Smart |
0 |
Doručení pouze na Parcelshop |
|
|
SMAD |
47 |
PPL Parcel
CZ Smart – dobírka |
1 |
Doručení pouze na Parcelshop |
|
SMEU |
48 |
PPL Parcel Smart Europe |
0 |
Pouze na Parcelshop v povolených
zemích. Aktuální informace na www.ppl.cz nebo obchodního zástupce PPL |
|
SMED |
49 |
PPL Parcel Smart Europe – dobírka |
1 |
Pouze na Parcelshop v povolených
zemích. Aktuální informace na www.ppl.cz nebo obchodního zástupce PPL |
|
RECI |
50 |
PPL Parcel Return Connect Import |
0 |
Vratná etiketa Return Connect, která směřuje do země CZ |
|
RECE |
PPL Parcel Return Connect EU |
0 |
Vratná etiketa Return Connect, která se
vrací v rámci EU |
|
Kód |
Země |
Kód |
Země |
|
CZ |
Česká republika |
ES |
Španělsko |
|
DE |
Německo |
FR |
Francie |
|
GB |
Velká Británíe |
IE |
Irsko |
|
SK |
Slovensko |
IT |
Itálie |
|
AT |
Rakousko |
NL |
Holandsko |
|
PL |
Polsko |
NO |
Norsko |
|
CH |
Švýcarsko |
PT |
Portugalsko |
|
FI |
Finsko |
SE |
Švédsko |
|
HU |
Maďarsko |
RO |
Rumunsko |
|
SI |
Slovinsko |
BG |
Bulharsko |
|
LV |
Lotyšsko |
GR |
Řecko |
|
EE |
Estonsko |
HR |
Chorvatsko |
|
LT |
Litva |
LU |
Lucembursko |
|
BE |
Belgie |
|
|
|
DK |
Dánsko |
|
|
|
Code |
Name |
|
CZK |
Česká koruna |
|
EUR |
Euro |
|
PLN |
Polský zlozy |
|
HUF |
Maďarský forint |
|
RON |
Rumunsko |
|
Typ |
Popis |
|
IN |
Vstupní směr (RouteType „IN“ dodá PPL) |
|
OUT |
Výstupní směr |
|
Popis |
Kód |
Popis |
Podmínka |
|
SmartLabel |
SL |
Typ
štítku |
Informace,
o typu štítku, který zákazník tiskne a informací o routování
na úrovni ulice |
|
Common Label |
CL |
Typ
zahraničního štítku |
Informace,
o typu štítku, který zákazník tiskne do zahraničí |
|
Code |
|
|
Externí |
B2CO |
|
Zákaznické |
CUST |
|
Variabilní symbol pro nonCOD |
VARS |
|
Externí párové číslo |
PSN |
|
Parcel Connect |
PJJD |
|
Postnummer pro DHL DE boxy |
POSN |
|
Name |
|
ParcelShop |
|
ParcelBox |
|
AlzaBox |
|
Name |
Code |
Name |
Code |
|
Externí |
B2CO |
Poplatek za TCP |
TCPF |
|
Zákaznické |
CUST |
Objednávková přeprava |
OBJP |
|
Partnerské |
PRTN |
Atyp Balík |
ATPB |
|
AWB |
CAWB |
ADR LQ |
ADRL |
|
JJD parcel
connect |
PJJD |
Sobotní svoz |
SOSV |
|
Dopravné |
B2OC |
Zdravotní prostředky |
ZDRP |
|
Mýtné |
TOLL |
Svoz
řidičem (Předplacený svoz řidičem) |
PUBC |
|
Zvýšená odpovědnost |
INSR |
Variabilní
symbol pro nonCOD |
VARS |
|
Platba
kartou |
PBC |
Palivový
příplatek |
FUEL |
|
Garance
pokusu o doručení D+1 |
GD1 |
Dobírka |
COD |
|
Zpět
odesílateli |
BCKS |
Potvrzení
o doručení |
POD |
|
Další
pokus doručení |
DPOD |
Mýtné SK |
TLSK |
|
Direct addressing |
DIAD |
AgeCheck |
AGCH |
|
Kód |
Popis |
Kód |
Popis |
|
150 |
Převzetí od zákazníka |
463 |
Nedoručeno – neobjednáno |
|
151 |
Převzetí s výhradou |
464 |
Nedoručeno – odmítnuto vyexpedováno pozdě |
|
281 |
Příjem zahraničí |
465 |
Nedoručeno – odmítnuto zásilka nekompletní |
|
300 |
Příjem na rozvozové depo |
466 |
Nedoručeno – odmítnuto jiný důvod |
|
336 |
Nevyzvednutý osobní odběr |
467 |
Nedoručeno – adresa neúplná/nenalezena |
|
343 |
Doručení na KTM |
468 |
Nedoručeno – nepřipravená hotovost |
|
400 |
Evidence na PL |
469 |
Nedoručeno – dovolená |
|
450 |
Doručeno |
470 |
Nedoručeno – zdržení na celnici |
|
451 |
Doručeno nekompletní |
471 |
Nedoručeno – chybné nebo chybějící doklady |
|
453 |
Doručeno s výhradou |
472 |
Nedoručeno – zásilka poškozena |
|
454 |
Nedoručeno – Nestihl |
500 |
Příjem na centrálu |
|
455 |
Nedoručeno – pozdní dojezd zásilek na depo |
605 |
Dobírka – příkaz na zákazníka |
|
456 |
Nedoručeno – porucha vozu |
606 |
Dobírka – zaplaceno zákazníkovi |
|
457 |
Nedoručeno – špatné počasí |
613 |
Dobírka – příkaz partnerovi |
|
458 |
Nedoručeno – příjemce nezastižen / oznámení |
614 |
Dobírka – zaplaceno partnerovi |
|
459 |
Nedoručeno – příjemce nezastižen / bez oznámení |
710 |
Převážení/vážení |
|
460 |
Nedoručeno – dohoda jiný termín |
718 |
Zpět odesílateli |
|
461 |
Nedoručeno – dohoda osobní odběr |
720 |
Výdej partnerovi |
|
462 |
Nedoručeno – dohoda jiná adresa |
927 |
Výmaz |
|
463 |
Nedoručeno – neobjednáno |
929 |
Příjem na jiné depo – závlek |
|
Name |
Popis |
StatusID |
Popis |
|
DataShipment |
Datová zásilky |
900 |
Import dat |
|
PickedUpFromSender |
Převzato od zákazníka |
150 |
Převzetí od zákazníka |
|
|
|
151 |
Převzetí s výhradou |
|
|
|
170 |
Příjem od zákazníka – zahraničí |
|
Delivered |
Doručeno |
450 |
Doručeno |
|
|
|
451 |
Doručeno nekompletní |
|
|
|
453 |
Doručeno s výhradou |
|
NotDelivered |
Nedoručeno |
336 |
Nevyzvednutý osobní odběr |
|
|
|
454 |
Nedoručeno – Nestihl |
|
|
|
455 |
Nedoručeno – pozdní dojezd zásilek na depo |
|
|
|
456 |
Nedoručeno – porucha vozu |
|
|
|
457 |
Nedoručeno – špatné počasí |
|
|
|
458 |
Nedoručeno – příjemce nezastižen / oznámení |
|
|
|
459 |
Nedoručeno – příjemce nezastižen / bez oznámení |
|
|
|
460 |
Nedoručeno – dohoda jiný termín |
|
|
|
461 |
Nedoručeno – dohoda osobní odběr |
|
|
|
462 |
Nedoručeno – dohoda jiná adresa |
|
|
|
463 |
Nedoručeno – neobjednáno |
|
|
|
464 |
Nedoručeno – odmítnuto vyexpedováno pozdě |
|
|
|
465 |
Nedoručeno – odmítnuto zásilka nekompletní |
|
|
|
466 |
Nedoručeno – odmítnuto jiný důvod |
|
|
|
467 |
Nedoručeno – adresa neúplná/nenalezena |
|
|
|
468 |
Nedoručeno – nepřipravená hotovost |
|
|
|
469 |
Nedoručeno – dovolená |
|
|
|
470 |
Nedoručeno – zdržení na celnici |
|
|
|
471 |
Nedoručeno – chybné nebo chybějící doklady |
|
|
|
472 |
Nedoručeno – zásilka poškozena |
|
|
|
478 |
Nedoručeno – Zavřeno |
|
|
|
718 |
Zpět odesílateli |
|
|
|
993 |
Nedoručeno. Není možné kontaktovat odesílatele |
|
BackToSender |
Vráceno odesílateli |
|
Je vyplněno „BackDate“ |
|
OutForDelivery |
Doručováno příjemci |
281 |
Příjem zahraničí |
|
|
|
282 |
Příjem zásilky v zahraničí |
|
|
|
300 |
Příjem na rozvozové depo |
|
|
|
343 |
Doručení na KTM |
|
|
|
400 |
Evidence na PL |
|
|
|
500 |
Příjem na centrálu |
|
|
|
720 |
Výdej partnerovi |
|
|
|
733 |
Příjem na výstupním depu – zahraničí |
|
|
|
734 |
Výdej z výstupního depa – zahraničí |
|
|
|
929 |
Příjem na jiné depo – závlek |
|
CodPaidDate |
Dobírka zaplacena zákazníkovi |
605 |
Dobírka – příkaz na zákazníka |
|
|
|
606 |
Dobírka – zaplaceno zákazníkovi |
|
|
|
613 |
Dobírka – příkaz partnerovi |
|
|
|
614 |
Dobírka – zaplaceno partnerovi |
|
Popis |
Kód |
Code - CreatePackg |
Platný pro produkty typu |
Podmínka |
|
Dobírka |
COD |
COD |
2, 8, 10, 14, 37 |
Ve službách se neuvádí. Je deklarována pomocí PaymentInfo. |
|
Platba v hotovosti
příjemcem |
EXW |
EXW |
- |
|
|
Připojištění |
INSR |
INSR |
1, 2, 7, 8, 9, 10, 11, 13, 14, |
- |
|
Dopolední
balík |
MD |
MD |
7, 8 |
Ve službách se neuvádí. Jedná se o produkt. |
|
A15 |
A15 |
13,
14 |
Kontrola
věku příjemce – 15+ |
|
|
AgeCheck – 18+ |
A18 |
A18 |
13,
14 |
Kontrola
věku příjemce – 18+ |
|
Svoz řidičem |
PUBC |
PUBC |
13,
14 (45), 50, 51 |
Je platný
pouze s produktem PPL Return CZ/Import/EU |
|
Další pokus doručení |
DPOD |
DPOD |
13,
14 |
|
|
Popis |
Kód |
Code - CreatePackg |
Popis |
Podmínka |
|
Adresa pro vrácení nedoručených zásilek |
BP |
BP |
1,2,7,
8, 9,10, 13,14,36,37 |
|
|
Adresa/služba pro vrácení return zásilek |
RETD |
RETD |
13,
14, 45, 46, 47 |
Pouze
s produkty PPL Parcel CZ Private + dob |
|
Adresa/služba
pro vrácení Return connect zásilek |
RETC |
RETC |
36, 37, 48,49,50,51 |
Pouze s produkty Parcel Connect |
|
Popis |
StatusID |
Popis |
Popis |
|
|
Created |
Vytvořena |
|
Objednávka vytvořena objednavatelem |
|
|
PickedUp |
Vyzvednuta |
|
Objednávka
byla vyzvednuta |
|
|
NotPickedUp |
Nevyzvednuto |
|
Objednávka
nebyla realizována |
|
|
|
|
156 |
Odesilatel
nenalezen / nedostatečná adresa |
Sender not found / Insufficient address |
|
|
|
157 |
Odesílatel
nezastižen – zavřeno |
Sender not reached - closed |
|
|
|
158 |
Porucha
vozu |
Car failure |
|
|
|
159 |
Storno
potvrzeno odes. |
Cancellation confirmed by sender |
|
|
|
160 |
Řidič
nestihl |
The driver didn't make it in time |
|
|
|
161 |
Dohoda na
jiný termín |
Agreement for another date |
|
|
|
162 |
Zásilka
nepřipravena |
Shipment not ready |
|
Canceled |
Storno |
|
Objednávka
byla stornována |
The order has been canceled |
|
Kód |
Popis |
Kód |
Popis |
|
0 |
Loaded successfully |
1036 |
Saturday delivery filled and saturday route not or vice versa |
|
1 |
Create packages failed |
1037 |
Missing input destination |
|
1000 |
Invalid or missing Package Number |
1038 |
Missing output destination |
|
1001 |
Unknown Package product type |
1039 |
Filled route type in and not route type out or vice versa. Two times filled
route type out or route type in |
|
1002 |
Bad sender address |
1040 |
Unknown package flag |
|
1003 |
Bad recipient address |
1043 |
SD flag can't be specified for this Product
type |
|
1004 |
Invalid COD variable
symbol |
1046 |
„Recipient coutry“ ZipCode wrong, check the format |
|
1005 |
Invalid specific symbol |
1047 |
Bad sender ZipCode format |
|
1006 |
COD price and COD currency must be filled |
1048 |
Parameter SpecTakeDate must be specified |
|
1007 |
COD negative price |
1049 |
COD price is greater than
the maximum allowable
limit for the country |
|
1008 |
Invalid bank informations
– filled bank account/code and also IBAN/SWIFT |
1050 |
Maximum number of packages „limit max počet
zásilek“ exceeded (1000) |
|
1009 |
Bank account and bank code must be
filled both |
1051 |
Value of key
with name MaxInsurance is not decimal (Hodnota připojištění není číslo) Value of key
with name MaxCODPrice is not decimal (Hodnota dobírky není číslo) Value of key
with name MaxPackagesInCount is not int (Počet zásilek není číslo) |
|
1010 |
IBAN and SWIFT must be filled both |
1052 |
The PackNumber is required field
(PackNumber je povinné pole) |
|
1011 |
Unknown bank code |
1053 |
Duplicit PackNumber: „PackNumber“ |
|
1012 |
Unknown SWIFT code |
1054 |
Insurance price must be lower
or equal to „limit max
částka připojištění“ |
|
1013 |
CodPrice, CodeCurrency, VS, SS,
BankCode, BankAccount,
IBAN a SWIFT can't be specified for non COD product |
1055 |
Maximum number of packages „limit max počet
zásilek“ exceeded |
|
1023 |
Unknown ParcelShop code |
1057 |
The PackNumber is required field |
|
1024 |
Invalid package weight |
1058 |
Duplicit PackNumber: „PackNumber“ |
|
1025 |
Insurance price and currency must be filled both |
1059 |
Package „PackNumber“ is not authorized to create back documents |
|
1026 |
Insurance negative price |
1060 |
Package: „PackNumber“, DocumentsBack PackNumber is missing |
|
1027 |
Currency for the COD is not acceptable |
1061 |
Package: „PackNumber“, service with code DB is missing. |
|
1028 |
Unknown insurance currency |
1062 |
Invalid recipient address
for back documents |
|
1029 |
Unknown Package service |
1063 |
Recipient ZIP code doesn't support morning delivery |
|
1030 |
Unknown External number |
1065 |
PackageInSetNr is higher
then PackageInSet |
|
1031 |
Invalid country in sender
address |
1067 |
Missing Return CZ service
recipient address |
|
1032 |
Invalid country in recipient address |
1068 |
Missing Return CZ BackPackNumber |
|
1033 |
SpecTakeDate must be equal or
greater than the current date |
1071 |
COD price must be integer |
|
1034 |
Unknown routes |
1076 |
The service is not possible upon delivery to the pick-up point. |
|
1035 |
Service is not relevant for product type |
|
|
|
Kód |
Popis |
|
0 |
Loaded successfully |
|
1 |
Create order failed |
|
2001 |
Bad sender address |
|
2002 |
Bad count of packages |
|
2005 |
Invalid country in sender
address |
|
2006 |
SendDate must be equal or
greater than the current date |
|
2008 |
Parameter SendDate must be filled |
|
Kód |
Popis |
|
0 |
Loaded successfully
|
|
1 |
Create order failed |
|
3001 |
Bad recipient address |
|
3002 |
Bad sender address |
|
3003 |
Bad count of packages |
|
3004 |
Unknown product type for package |
|
3005 |
Invalid
country in sender address |
|
3006 |
Invalid
country in recipient address |
|
3007 |
SendDate must be equal or
greater than the current date. |
|
3008 |
Parameter SendDate must be filled |
|
3010 |
Duplicit
OrdRefId: „OrdRefID“ (Duplicitní OrdRefID) |
|
3011 |
Count of orders
is greater than „max limit pro počet objednávek“
(současné nastavení: 50) |
|
3012 |
Limit of packages per order |
|
Kód |
Popis |
|
0 |
Loaded successfully
|
|
4000 |
You have already unsused numbers of requested
range, contact sales or technician or IT |
|
4001 |
PackProductType does not exist |
|
4002 |
Quantity is above
maximum |
|
4003 |
Quantity is bellow
minimum |
|
AS36 |
Při zpracování došlo k chybě. Chyba byla zaznamenána
**.**.**** **:**:** (Zkontrolujte zadanou hodnotu
v položce „PackProductType“) |
PPL Parcel Business – bez COD, naprosté minimum
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>QTxAh9CwtILN3……….z253H6XyGHLf16kXFPWNuTDvgHA==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>80950589410</v1:PackNumber>
<v1:PackProductType>BUSS</v1:PackProductType>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Name>jmeno</v1:Name>
<v1:Street>ulice</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>80950589410</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>2</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
PPL Parcel Private – bez COD, kompletní kontakty
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>D0D79ZWtnJ/………….iKYj+awy2fZXp9ybw0O1dI4TFyw==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>40950121995</v1:PackNumber>
<v1:PackProductType>PRIV</v1:PackProductType>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Contact>kontaktniosoba</v1:Contact>
<v1:Email>kontaktni@email.cz</v1:Email>
<v1:Name>kontaktniosoba</v1:Name>
<v1:Phone>777111222</v1:Phone>
<v1:Street>ulice</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>40950121995</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>1</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
PPL Parcel Private – balík poslaný na Parcelshop s původní adresou příjemce
<?xml version="1.0"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>D0D79ZWtnJ/6K8QjWAQQ9OAFB…………..SGNJOStn+ ==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>40950121995</v1:PackNumber>
<v1:PackProductType>PRIV</v1:PackProductType>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Contact>kontaktniosoba</v1:Contact>
<v1:Email>kontaktni@email.cz</v1:Email>
<v1:Name>Name - Nazev Firmy</v1:Name>
<v1:Phone>777111222</v1:Phone>
<v1:Street>ulice</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:SpecDelivery>
<v1:ParcelShopCode>KM10128401</v1:ParcelShopCode>
</v1:SpecDelivery>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>40950121995</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>2</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
Pozn.:
Balík je pak zobrazován v systému PPL, viz obrázek. Dochází ke změně
adresy na adresu ParcelShopu.
PPL Parcel Private – balík poslaný na ParcelShop s adresou PS z GetParcelShops
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>D0D79ZWtnJJ+v…………….jSSGNJOStn+awybw0O1dI4TFyw==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>40950121995</v1:PackNumber>
<v1:PackProductType>PRIV</v1:PackProductType>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Contact>Kontakt, který si převezme balík</v1:Contact>
<v1:Email>kontaktni@email.cz</v1:Email>
<v1:Name>BuBuSport</v1:Name>
<v1:Name2>PPL Parcelshop 101</v1:Name2>
<v1:Phone>777123456</v1:Phone>
<v1:Street>ulice</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:SpecDelivery>
<v1:ParcelShopCode>KM10128401</v1:ParcelShopCode>
</v1:SpecDelivery>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>40950121995</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>1</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
PPL Parcel Private – bez COD, jeden balík
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>D0D79ZWtnJJ+v…………….jSSGNJOStn+awybw0O1dI4TFyw==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>40950262579</v1:PackNumber>
<v1:PackProductType>PRIV</v1:PackProductType>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Contact>Contakt</v1:Contact>
<v1:Email>contact@email.cz</v1:Email>
<v1:Name>Name</v1:Name>
<v1:Name2/>
<v1:Phone>721827252</v1:Phone>
<v1:Street>street</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>40950262579</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>1</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
PPL Parcel Private – COD, Připojištěný, s Ext. číslem
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>hwVotO0TOL1UOhf6wZNoh……………gYACBsyuj84ds7fILakTw==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>40990422619</v1:PackNumber>
<v1:PackProductType>PRID</v1:PackProductType>
<v1:Note>note</v1:Note>
<v1:DepoCode>09</v1:DepoCode>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Contact>kontakt</v1:Contact>
<v1:Country>CZ</v1:Country>
<v1:Email>jfnukal@ppl.cz</v1:Email>
<v1:Name>jmeno</v1:Name>
<v1:Name2>jmeno2</v1:Name2>
<v1:Phone>721827252</v1:Phone>
<v1:Street>ulice</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:PaymentInfo>
<v1:CodCurrency>CZK</v1:CodCurrency>
<v1:CodPrice>100</v1:CodPrice>
<v1:CodVarSym>12345</v1:CodVarSym>
<v1:InsurCurrency>CZK</v1:InsurCurrency>
<v1:InsurPrice>51000</v1:InsurPrice>
</v1:PaymentInfo>
<v1:PackagesExtNums>
<v1:MyApiPackageExtNum>
<v1:Code>B2CO</v1:Code>
<v1:ExtNumber>12345678EE</v1:ExtNumber>
</v1:MyApiPackageExtNum>
</v1:PackagesExtNums>
<v1:PackageSet>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:MasterPackNumber>40990422619</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>2</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
<v1:ReturnChannel/>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
PPL Parcel Private – Zvážený, první balík ze tří
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:AuthToken>D0D79ZWtnJJ+v…………….jSSGNJOStn+awybw0O1dI4TFyw==</v1:AuthToken>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>40950262579</v1:PackNumber>
<v1:PackProductType>PRIV</v1:PackProductType>
<v1:Recipient>
<v1:City>Olomouc</v1:City>
<v1:Contact>Contakt</v1:Contact>
<v1:Email>contact@email.cz</v1:Email>
<v1:Name>Name</v1:Name>
<v1:Name2/>
<v1:Phone>721827252</v1:Phone>
<v1:Street>street</v1:Street>
<v1:ZipCode>77200</v1:ZipCode>
</v1:Recipient>
<v1:PackageSet>
<v1:MasterPackNumber>40950262579</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>3</v1:PackagesInSet>
</v1:PackageSet>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>SL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:WeightedPackageInfo>
<v1:Weight>12.22</v1:Weight>
<v1:Routes>
<v1:Route>
<v1:RouteType>IN</v1:RouteType>
<v1:RouteCode>09999</v1:RouteCode>
</v1:Route>
<v1:Route>
<v1:RouteType>OUT</v1:RouteType>
<v1:RouteCode>09001</v1:RouteCode>
</v1:Route>
<v1:Route>
<v1:RouteType>OUT_SD</v1:RouteType>
<v1:RouteCode>09901</v1:RouteCode>
</v1:Route>
</v1:Routes>
</v1:WeightedPackageInfo>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
Return Connect – Balík do PL s Return zásilkou
PODMÍNKOU PRO PRODUKT RETURN CONNECT IMPORT a RETURN CONNECT EU JE
GENEROVÁNÍ ETIKET PARCEL CONNECT !!!
<?xml version="1.0"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:CustId>123456</v1:CustId>
<v1:Password>XX111111</v1:Password>
<v1:UserName>XX111111</v1:UserName>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>20691205735</v1:PackNumber>
<v1:PackProductType>COND</v1:PackProductType>
<v1:Note>PrniParcel Connect</v1:Note>
<v1:Recipient>
<v1:City>GLUCHOLAZY</v1:City>
<v1:Contact>kontakt</v1:Contact>
<v1:Country>PL</v1:Country>
<v1:Email>xxxxx@xxxxx.cz</v1:Email>
<v1:Name>1. return v myapi nosna adresa</v1:Name>
<v1:Name2>jmeno2</v1:Name2>
<v1:Phone>777 111 222</v1:Phone>
<v1:Street>straseadresa k prijemci</v1:Street>
<v1:ZipCode>48343</v1:ZipCode>
</v1:Recipient>
<v1:PaymentInfo>
<v1:CodCurrency>PLN</v1:CodCurrency>
<v1:CodPrice>10</v1:CodPrice>
<v1:CodVarSym>12345</v1:CodVarSym>
</v1:PaymentInfo>
<v1:PackagesExtNums>
<v1:MyApiPackageExtNum>
<v1:Code>PJJD</v1:Code>
<v1:ExtNumber>JJD149020422609500000026</v1:ExtNumber>
</v1:MyApiPackageExtNum>
</v1:PackagesExtNums>
<v1:PackageServices>
<v1:MyApiPackageInServices>
<v1:SvcCode>PUBC</v1:SvcCode>
</v1:MyApiPackageInServices>
</v1:PackageServices>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>CL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>20691205733</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>1</v1:PackagesInSet>
</v1:PackageSet>
<v1:AddressesForServices>
<v1:AddressForService>
<v1:ServiceAddressType>RETC</v1:ServiceAddressType>
<v1:BackPackNumber>20600028638</v1:BackPackNumber>
<v1:PackNrRetConnect>JJD149020422609500000027</v1:PackNrRetConnect>
<v1:Recipient>
<v1:City>Krnov</v1:City>
<v1:Contact>Contactreturn conn</v1:Contact>
<v1:Country>CZ</v1:Country>
<v1:Email>jfnukal@ppl.cz</v1:Email>
<v1:Name>Jarek Fnukalu return</v1:Name>
<v1:Name2>name2 return</v1:Name2>
<v1:Phone>987654321</v1:Phone>
<v1:Street>ulice return 1</v1:Street>
<v1:ZipCode>79401</v1:ZipCode>
</v1:Recipient>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>CL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
</v1:AddressForService>
</v1:AddressesForServices>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>
Return Connect – (pouze) Return zásilka
PODMÍNKOU PRO PRODUKT RETURN CONNECT IMPORT a RETURN CONNECT EU JE
GENEROVÁNÍ ETIKET PARCEL CONNECT !!!
<?xml version="1.0"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://myapi.ppl.cz/v1"><soapenv:Header/>
<soapenv:Body>
<v1:CreatePackages>
<v1:Auth>
<v1:CustId>1234564</v1:CustId>
<v1:Password>XX1234654</v1:Password>
<v1:UserName>XX1234654</v1:UserName>
</v1:Auth>
<v1:Packages>
<v1:MyApiPackageIn>
<v1:PackNumber>20950215792</v1:PackNumber>
<v1:PackProductType>RECI</v1:PackProductType>
<v1:Note>PrniParcel Connect</v1:Note>
<v1:Sender>
<v1:City>Berlin</v1:City>
<v1:Contact>kontakt</v1:Contact>
<v1:Country>DE</v1:Country>
<v1:Email>ginter@aaaaa.de</v1:Email>
<v1:Name>1. return v myapi nosna adresa</v1:Name>
<v1:Name2>jmeno2</v1:Name2>
<v1:Phone>+491234564789</v1:Phone>
<v1:Street>straseadresa k prijemci</v1:Street>
<v1:ZipCode>10115</v1:ZipCode>
</v1:Sender>
<v1:Recipient>
<v1:City>Ostrava</v1:City>
<v1:Contact>kontakt</v1:Contact>
<v1:Country>CZ</v1:Country>
<v1:Email>jarek.ppl@xxxxxx.cz</v1:Email>
<v1:Name>1. return v myapi nosna adresa</v1:Name>
<v1:Name2>jmeno2</v1:Name2>
<v1:Phone>733 111 222</v1:Phone>
<v1:Street>straseadresa k prijemci</v1:Street>
<v1:ZipCode>72200</v1:ZipCode>
</v1:Recipient>
<v1:PackagesExtNums>
<v1:MyApiPackageExtNum>
<v1:Code>PJJD</v1:Code>
<v1:ExtNumber>JJD149020422609500000044</v1:ExtNumber>
</v1:MyApiPackageExtNum>
</v1:PackagesExtNums>
<v1:PackageServices>
<v1:MyApiPackageInServices>
<v1:SvcCode>PUBC</v1:SvcCode>
</v1:MyApiPackageInServices>
</v1:PackageServices>
<v1:Flags>
<v1:MyApiFlag>
<v1:Code>CL</v1:Code>
<v1:Value>1</v1:Value>
</v1:MyApiFlag>
</v1:Flags>
<v1:PackageSet>
<v1:MasterPackNumber>20950215792</v1:MasterPackNumber>
<v1:PackageInSetNr>1</v1:PackageInSetNr>
<v1:PackagesInSet>1</v1:PackagesInSet>
</v1:PackageSet>
</v1:MyApiPackageIn>
</v1:Packages>
</v1:CreatePackages>
</soapenv:Body>
</soapenv:Envelope>